Parameter |
Choices/Defaults |
Comments |
action
|
|
The action to perform when the operation value is set to action .
Some common values for this parameter are enable , disable , rename .
|
args
|
|
A dictionary which defines the key arguments by which we will select the Nitro object to operate on.
It is required for the following operation values: get_by_args , 'delete_by_args' .
|
attributes
|
|
The attributes of the Nitro object we are operating on.
It is required for the following operation values: add , update , action .
|
expected_nitro_errorcode
required |
Default:
[0]
|
A list of numeric values that signify that the operation was successful.
|
filter
|
|
A dictionary which defines the filter with which to refine the Nitro objects returned by the get_filtered operation.
|
instance_id
|
|
The id of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
|
instance_ip
|
|
The IP address of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
|
instance_name
|
|
The name of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
|
name
|
|
The name of the resource we are operating on.
It is required for the following operation values: update , get , delete .
|
nitro_auth_token
|
|
The authentication token provided by the mas_login operation. It is required when issuing Nitro API calls through a MAS proxy.
|
nitro_pass
required |
|
The password with which to authenticate to the Netscaler node.
|
nitro_protocol
|
|
Which protocol to use when accessing the Nitro API objects.
|
nitro_user
required |
|
The username with which to authenticate to the Netscaler node.
|
nsip
|
|
The IP address of the Netscaler or MAS instance where the Nitro API calls will be made.
The port can be specified with the colon : . E.g. 192.168.1.1:555 .
|
operation
|
Choices:
- add
- update
- get
- get_by_args
- get_filtered
- get_all
- delete
- delete_by_args
- count
- mas_login
- save_config
- action
|
Define the Nitro operation that we want to perform.
|
resource
|
|
The type of resource we are operating on.
It is required for all operation values except mas_login and save_config .
|
validate_certs
|
Default:
yes
|
If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
|