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
選填

Sort field and order, eg. ‘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.