Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
search optional |
filter results Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
Page number, starting at 1 Validations:
|
per_page optional |
Number of results per page to return, 'all' to return all results Validations:
|
Field name | Type | Possible values |
---|---|---|
ansible_role | ||
avoid_duplicates | true, false | |
imported | true, false | |
key | ||
merge_default | true, false | |
merge_overrides | true, false | |
name | ||
override | true, false | |
parameter |
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
ansible_variable required |
Validations:
|
ansible_variable[variable] required |
Name of variable Validations:
|
ansible_variable[ansible_role_id] required |
Role ID Validations:
|
ansible_variable[default_value] optional , nil allowed |
Default value of variable Validations:
|
ansible_variable[hidden_value] optional , nil allowed |
When enabled the parameter is hidden in the UI Validations:
|
ansible_variable[override_value_order] optional , nil allowed |
The order in which values are resolved Validations:
|
ansible_variable[description] optional , nil allowed |
Description of variable Validations:
|
ansible_variable[validator_type] optional , nil allowed |
Types of validation values Validations:
|
ansible_variable[validator_rule] optional , nil allowed |
Used to enforce certain values for the parameter values Validations:
|
ansible_variable[variable_type] optional , nil allowed |
Types of variable values Validations:
|
ansible_variable[merge_overrides] optional , nil allowed |
Merge all matching values (only array/hash type) Validations:
|
ansible_variable[merge_default] optional , nil allowed |
Include default value when merging all matching values Validations:
|
ansible_variable[avoid_duplicates] optional , nil allowed |
Remove duplicate values (only array type) Validations:
|
ansible_variable[override] optional , nil allowed |
Whether to override variable or not Validations:
|
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
id required |
Validations:
|
ansible_variable required |
Validations:
|
ansible_variable[variable] optional |
Name of variable Validations:
|
ansible_variable[ansible_role_id] optional |
Role ID Validations:
|
ansible_variable[default_value] optional , nil allowed |
Default value of variable Validations:
|
ansible_variable[hidden_value] optional , nil allowed |
When enabled the parameter is hidden in the UI Validations:
|
ansible_variable[override_value_order] optional , nil allowed |
The order in which values are resolved Validations:
|
ansible_variable[description] optional , nil allowed |
Description of variable Validations:
|
ansible_variable[validator_type] optional , nil allowed |
Types of validation values Validations:
|
ansible_variable[validator_rule] optional , nil allowed |
Used to enforce certain values for the parameter values Validations:
|
ansible_variable[variable_type] optional , nil allowed |
Types of variable values Validations:
|
ansible_variable[merge_overrides] optional , nil allowed |
Merge all matching values (only array/hash type) Validations:
|
ansible_variable[merge_default] optional , nil allowed |
Include default value when merging all matching values Validations:
|
ansible_variable[avoid_duplicates] optional , nil allowed |
Remove duplicate values (only array type) Validations:
|
ansible_variable[override] optional , nil allowed |
Whether to override variable or not Validations:
|
DEPRECATED
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
proxy_id required |
Smart Proxy to import from Validations:
|
DEPRECATED
Param name | Description |
---|---|
location_id optional |
Set the current location context for the request Validations:
|
organization_id optional |
Set the current organization context for the request Validations:
|
proxy_id required |
Smart Proxy to import from Validations:
|