Documentation

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

The below requirements are needed on the host that executes this module.

  • nitro python sdk

Parameters

Parameter Choices/Defaults Comments
comment
-
Comments associated with this cs action.
name
-
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
string / required
The password with which to authenticate to the netscaler node.
nitro_protocol
string
    Choices:
  • http ←
  • https
Which protocol to use when accessing the nitro API objects.
nitro_timeout
float
Default:
310
Time in seconds until a timeout error is thrown when establishing a new session with Netscaler
nitro_user
string / required
The username with which to authenticate to the netscaler node.
nsip
string / required
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
boolean
    Choices:
  • no
  • yes ←
If yes 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
string
    Choices:
  • absent
  • present ←
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
-
Name of the load balancing virtual server to which the content is switched.
targetvserver
-
Name of the VPN virtual server to which the content is switched.
targetvserverexpr
-
Information about this content switching action.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Notes

Note

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, the following are the fields unique to this module:

Key Returned Description
diff
dictionary
failure
List of differences between the actual configured object and the configuration specified in the module

Sample:
{ 'targetlbvserver': 'difference. ours: (str) server1 other: (str) server2' }
loglines
list
always
list of logged messages by the module

Sample:
['message 1', 'message 2']
msg
string
failure
Message detailing the failure reason

Sample:
Action does not exist


Status

Authors

  • George Nikolopoulos (@giorgos-nikolopoulos)

Hint

If you notice any issues in this documentation you can edit this document to improve it.