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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

ansible_variable
必須

Validations:

  • Must be a Hash

ansible_variable[variable]
必須

変数の名前

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
必須

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
任意 , nil可

変数のデフォルト値

Validations:

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

ansible_variable[hidden_value]
任意 , nil可

有効な場合はパラメーターが UI で非表示になります

Validations:

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

ansible_variable[override_value_order]
任意 , nil可

値が解決される順序

Validations:

  • Must be a String

ansible_variable[description]
任意 , nil可

変数の説明

Validations:

  • Must be a String

ansible_variable[validator_type]
任意 , nil可

検証値のタイプ

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
任意 , nil可

パラメーター値の特定の値を適用するために使用されます

Validations:

  • Must be a String

ansible_variable[variable_type]
任意 , nil可

変数値のタイプ

Validations:

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

ansible_variable[merge_overrides]
任意 , nil可

一致するすべての値のマージ (配列/ハッシュタイプのみ)

Validations:

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

ansible_variable[merge_default]
任意 , nil可

一致するすべての値をマージするときにデフォルト値を含めます

Validations:

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

ansible_variable[avoid_duplicates]
任意 , nil可

重複する値の削除 (配列タイプのみ)

Validations:

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


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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

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
必須

Validations:

  • Must be a Hash

ansible_variable[variable]
任意

変数の名前

Validations:

  • Must be a String

ansible_variable[ansible_role_id]
任意

Role ID

Validations:

  • Must be a number.

ansible_variable[default_value]
任意 , nil可

変数のデフォルト値

Validations:

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

ansible_variable[hidden_value]
任意 , nil可

有効な場合はパラメーターが UI で非表示になります

Validations:

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

ansible_variable[override_value_order]
任意 , nil可

値が解決される順序

Validations:

  • Must be a String

ansible_variable[description]
任意 , nil可

変数の説明

Validations:

  • Must be a String

ansible_variable[validator_type]
任意 , nil可

検証値のタイプ

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
任意 , nil可

パラメーター値の特定の値を適用するために使用されます

Validations:

  • Must be a String

ansible_variable[variable_type]
任意 , nil可

変数値のタイプ

Validations:

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

ansible_variable[merge_overrides]
任意 , nil可

一致するすべての値のマージ (配列/ハッシュタイプのみ)

Validations:

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

ansible_variable[merge_default]
任意 , nil可

一致するすべての値をマージするときにデフォルト値を含めます

Validations:

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

ansible_variable[avoid_duplicates]
任意 , nil可

重複する値の削除 (配列タイプのみ)

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

proxy_id
必須

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

proxy_id
必須

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.