GET /ansible/api/ansible_variables/:id
Show variable

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


GET /ansible/api/ansible_variables
List Ansible variables

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


DELETE /ansible/api/ansible_variables/:id
Deletes Ansible variable

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /ansible/api/ansible_variables
Create Ansible variable

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

ansible_variable
verpflichtend

Validations:

  • Must be a Hash

ansible_variable[variable]
verpflichtend

Name der Variable

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
verpflichtend

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
optional , nil erlaubt

Standardwert der Variable

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json

ansible_variable[hidden_value]
optional , nil erlaubt

Wenn aktiviert, so ist der Parameter im UI verborgen

Validations:

  • Must be one of: true, false, 1, 0.

ansible_variable[override_value_order]
optional , nil erlaubt

Reihenfolge, in der Werte aufgelöst werden

Validations:

  • Must be a String

ansible_variable[description]
optional , nil erlaubt

Beschreibung der Variable

Validations:

  • Must be a String

ansible_variable[validator_type]
optional , nil erlaubt

Typen von Validierungswerten

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
optional , nil erlaubt

Verwendet, um bestimmte Werte für die Parameterwerte umzusetzen

Validations:

  • Must be a String

ansible_variable[variable_type]
optional , nil erlaubt

Typen von Variablenwerten

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

ansible_variable[merge_overrides]
optional , nil erlaubt

Alle übereinstimmenden Werte (nur vom Typ Array/Hash) zusammenführen

Validations:

  • Must be one of: true, false, 1, 0.

ansible_variable[merge_default]
optional , nil erlaubt

Standardwert einschließen, wenn alle übereinstimmenden Werte zusammengeführt werden

Validations:

  • Must be one of: true, false, 1, 0.

ansible_variable[avoid_duplicates]
optional , nil erlaubt

Duplikate (nur vom Typ Array) entfernen

Validations:

  • Must be one of: true, false, 1, 0.


PUT /ansible/api/ansible_variables/:id
Updates Ansible variable

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

ansible_variable
verpflichtend

Validations:

  • Must be a Hash

ansible_variable[variable]
optional

Name der Variable

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
optional

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
optional , nil erlaubt

Standardwert der Variable

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json

ansible_variable[hidden_value]
optional , nil erlaubt

Wenn aktiviert, so ist der Parameter im UI verborgen

Validations:

  • Must be one of: true, false, 1, 0.

ansible_variable[override_value_order]
optional , nil erlaubt

Reihenfolge, in der Werte aufgelöst werden

Validations:

  • Must be a String

ansible_variable[description]
optional , nil erlaubt

Beschreibung der Variable

Validations:

  • Must be a String

ansible_variable[validator_type]
optional , nil erlaubt

Typen von Validierungswerten

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
optional , nil erlaubt

Verwendet, um bestimmte Werte für die Parameterwerte umzusetzen

Validations:

  • Must be a String

ansible_variable[variable_type]
optional , nil erlaubt

Typen von Variablenwerten

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

ansible_variable[merge_overrides]
optional , nil erlaubt

Alle übereinstimmenden Werte (nur vom Typ Array/Hash) zusammenführen

Validations:

  • Must be one of: true, false, 1, 0.

ansible_variable[merge_default]
optional , nil erlaubt

Standardwert einschließen, wenn alle übereinstimmenden Werte zusammengeführt werden

Validations:

  • Must be one of: true, false, 1, 0.

ansible_variable[avoid_duplicates]
optional , nil erlaubt

Duplikate (nur vom Typ Array) entfernen

Validations:

  • Must be one of: true, false, 1, 0.


PUT /ansible/api/ansible_variables/import
Import Ansible variables. This will only import variables for already existing roles, it will not import any new roles

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

proxy_id
verpflichtend

Smart Proxy to import from

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


PUT /ansible/api/ansible_variables/obsolete
Obsolete Ansible variables. This will only obsolete variables for already existing roles, it will not delete any old roles

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

proxy_id
verpflichtend

Smart Proxy to import from

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.