netscaler_cs_action - Manage content switching actions

New in version 2.4.0.

Synopsis

  • Manage content switching actions
  • This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance

Requirements (on host that executes module)

  • nitro python sdk

Options

parameter required default choices comments
comment
 no
Comments associated with this cs action.
name
 no
Name for the content switching action. Must begin with an ASCII alphanumeric or underscore _ character, and must contain only ASCII alphanumeric, underscore _, hash #, period ., space , colon :, at sign @, equal sign =, and hyphen - characters. Can be changed after the content switching action is created.
nitro_pass
 yes
The password with which to authenticate to the netscaler node.
nitro_protocol
 no http
  • http
  • https
Which protocol to use when accessing the nitro API objects.
nitro_timeout
 no 310
Time in seconds until a timeout error is thrown when establishing a new session with Netscaler
nitro_user
 yes
The username with which to authenticate to the netscaler node.
nsip
 yes
The ip address of the netscaler appliance where the nitro API calls will be made.
The port can be specified with the colon (:). E.g. 192.168.1.1:555.
save_config
 no True
  • yes
  • no
If true the module will save the configuration on the netscaler node if it makes any changes.
The module will not save the configuration on the netscaler node if it made no changes.
state
 no present
  • present
  • absent
The state of the resource being configured by the module on the netscaler node.
When present the resource will be created if needed and configured according to the module's parameters.
When absent the resource will be deleted from the netscaler node.
targetlbvserver
 no
Name of the load balancing virtual server to which the content is switched.
targetvserver
 no
Name of the VPN virtual server to which the content is switched.
targetvserverexpr
 no
Information about this content switching action.
validate_certs
 no yes
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

# lb_vserver_1 must have been already created with the netscaler_lb_vserver module

- name: Configure netscaler content switching action
  delegate_to: localhost
  netscaler_cs_action:
      nsip: 172.18.0.2
      nitro_user: nsroot
      nitro_pass: nsroot
      validate_certs: no

      state: present

      name: action-1
      targetlbvserver: lb_vserver_1

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
diff
List of differences between the actual configured object and the configuration specified in the module
 failure dictionary { 'targetlbvserver': 'difference. ours: (str) server1 other: (str) server2' }
loglines
list of logged messages by the module
 always list ['message 1', 'message 2']
msg
Message detailing the failure reason
 failure string Action does not exist

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/netscaler_cs_action_module.html