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]
选填 , 允许空值

变量的默认值

Validations:

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

ansible_variable[hidden_value]
选填 , 允许空值

何时将启用的参数隐藏到 UI 中

Validations:

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

ansible_variable[override_value_order]
选填 , 允许空值

解析参数值的指令

Validations:

  • Must be a String

ansible_variable[description]
选填 , 允许空值

变量描述

Validations:

  • Must be a String

ansible_variable[validator_type]
选填 , 允许空值

验证值类型

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
选填 , 允许空值

用来在参数中强制使用某些值

Validations:

  • Must be a String

ansible_variable[variable_type]
选填 , 允许空值

变量值类型

Validations:

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

ansible_variable[merge_overrides]
选填 , 允许空值

合并所有匹配的值(仅用于阵列/哈希类型)

Validations:

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

ansible_variable[merge_default]
选填 , 允许空值

合并所有匹配值时包括默认值

Validations:

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

ansible_variable[avoid_duplicates]
选填 , 允许空值

删除重复值(仅用于阵列类型)

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]
选填 , 允许空值

变量的默认值

Validations:

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

ansible_variable[hidden_value]
选填 , 允许空值

何时将启用的参数隐藏到 UI 中

Validations:

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

ansible_variable[override_value_order]
选填 , 允许空值

解析参数值的指令

Validations:

  • Must be a String

ansible_variable[description]
选填 , 允许空值

变量描述

Validations:

  • Must be a String

ansible_variable[validator_type]
选填 , 允许空值

验证值类型

Validations:

  • Must be one of: regexp, list.

ansible_variable[validator_rule]
选填 , 允许空值

用来在参数中强制使用某些值

Validations:

  • Must be a String

ansible_variable[variable_type]
选填 , 允许空值

变量值类型

Validations:

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

ansible_variable[merge_overrides]
选填 , 允许空值

合并所有匹配的值(仅用于阵列/哈希类型)

Validations:

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

ansible_variable[merge_default]
选填 , 允许空值

合并所有匹配值时包括默认值

Validations:

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

ansible_variable[avoid_duplicates]
选填 , 允许空值

删除重复值(仅用于阵列类型)

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.