Class: Ansible::Ruby::Modules::Netscaler_nitro_request
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Netscaler_nitro_request
- Defined in:
- lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb
Overview
Issue Nitro API requests to a Netscaler instance. This is intended to be a short hand for using the uri Ansible module to issue the raw HTTP requests directly. It provides consistent return values and has no other dependencies apart from the base Ansible runtime environment. This module is intended to run either on the Ansible control node or a bastion (jumpserver) with access to the actual Netscaler instance
Instance Method Summary collapse
-
#action ⇒ String?
The action to perform when the I(operation) value is set to C(action).,Some common values for this parameter are C(enable), C(disable), C(rename).
-
#args ⇒ Hash?
A dictionary which defines the key arguments by which we will select the Nitro object to operate on.,It is required for the following I(operation) values: C(get_by_args), C(‘delete_by_args’).
-
#attributes ⇒ Hash?
The attributes of the Nitro object we are operating on.,It is required for the following I(operation) values: C(add), C(update), C(action).
-
#expected_nitro_errorcode ⇒ Integer
A list of numeric values that signify that the operation was successful.
-
#filter ⇒ Hash?
A dictionary which defines the filter with which to refine the Nitro objects returned by the C(get_filtered) I(operation).
-
#instance_id ⇒ Object?
The id of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
-
#instance_ip ⇒ String?
The IP address of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
-
#instance_name ⇒ Object?
The name of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
-
#name ⇒ String?
The name of the resource we are operating on.,It is required for the following I(operation) values: C(update), C(get), C(delete).
-
#nitro_auth_token ⇒ String?
The authentication token provided by the C(mas_login) operation.
-
#nitro_pass ⇒ String
The password with which to authenticate to the Netscaler node.
-
#nitro_protocol ⇒ :http, ...
Which protocol to use when accessing the Nitro API objects.
-
#nitro_user ⇒ String
The username with which to authenticate to the Netscaler node.
-
#nsip ⇒ String?
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 C(:).
-
#operation ⇒ :add, ...
Define the Nitro operation that we want to perform.
-
#resource ⇒ String?
The type of resource we are operating on.,It is required for all I(operation) values except C(mas_login) and C(save_config).
-
#validate_certs ⇒ String?
If C(no), SSL certificates will not be validated.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#action ⇒ String?
Returns The action to perform when the I(operation) value is set to C(action).,Some common values for this parameter are C(enable), C(disable), C(rename).
67 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 67 attribute :action |
#args ⇒ Hash?
Returns A dictionary which defines the key arguments by which we will select the Nitro object to operate on.,It is required for the following I(operation) values: C(get_by_args), C(‘delete_by_args’).
51 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 51 attribute :args |
#attributes ⇒ Hash?
Returns The attributes of the Nitro object we are operating on.,It is required for the following I(operation) values: C(add), C(update), C(action).
47 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 47 attribute :attributes |
#expected_nitro_errorcode ⇒ Integer
Returns A list of numeric values that signify that the operation was successful.
63 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 63 attribute :expected_nitro_errorcode |
#filter ⇒ Hash?
Returns A dictionary which defines the filter with which to refine the Nitro objects returned by the C(get_filtered) I(operation).
55 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 55 attribute :filter |
#instance_id ⇒ Object?
Returns The id of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
78 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 78 attribute :instance_id |
#instance_ip ⇒ String?
Returns The IP address of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
71 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 71 attribute :instance_ip |
#instance_name ⇒ Object?
Returns The name of the target Netscaler instance when issuing a Nitro request through a MAS proxy.
75 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 75 attribute :instance_name |
#name ⇒ String?
Returns The name of the resource we are operating on.,It is required for the following I(operation) values: C(update), C(get), C(delete).
43 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 43 attribute :name |
#nitro_auth_token ⇒ String?
Returns The authentication token provided by the C(mas_login) operation. It is required when issuing Nitro API calls through a MAS proxy.
35 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 35 attribute :nitro_auth_token |
#nitro_pass ⇒ String
Returns The password with which to authenticate to the Netscaler node.
23 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 23 attribute :nitro_pass |
#nitro_protocol ⇒ :http, ...
Returns Which protocol to use when accessing the Nitro API objects.
27 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 27 attribute :nitro_protocol |
#nitro_user ⇒ String
Returns The username with which to authenticate to the Netscaler node.
19 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 19 attribute :nitro_user |
#nsip ⇒ String?
Returns 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 C(:). E.g. C(192.168.1.1:555).
15 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 15 attribute :nsip |
#operation ⇒ :add, ...
Returns Define the Nitro operation that we want to perform.
59 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 59 attribute :operation |
#resource ⇒ String?
Returns The type of resource we are operating on.,It is required for all I(operation) values except C(mas_login) and C(save_config).
39 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 39 attribute :resource |
#validate_certs ⇒ String?
Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
31 |
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_nitro_request.rb', line 31 attribute :validate_certs |