community.general.netscaler_cs_action (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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

• nitro python sdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Inputs

    
name:
    description:
    - Name for the content switching action. Must begin with an ASCII alphanumeric or
      underscore C(_) character, and must contain only ASCII alphanumeric, underscore
      C(_), hash C(#), period C(.), space C( ), colon C(:), at sign C(@), equal sign C(=),
      and hyphen C(-) characters. Can be changed after the content switching action is
      created.

nsip:
    description:
    - 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.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - 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.
    type: str

comment:
    description:
    - Comments associated with this cs action.

nitro_pass:
    description:
    - The password with which to authenticate to the netscaler node.
    required: true
    type: str

nitro_user:
    description:
    - The username with which to authenticate to the netscaler node.
    required: true
    type: str

save_config:
    default: true
    description:
    - If C(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.
    type: bool

nitro_timeout:
    default: 310
    description:
    - Time in seconds until a timeout error is thrown when establishing a new session
      with Netscaler
    type: float

targetvserver:
    description:
    - Name of the VPN virtual server to which the content is switched.

nitro_protocol:
    choices:
    - http
    - https
    default: http
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated. This should only be used on personally
      controlled sites using self-signed certificates.
    type: bool

targetlbvserver:
    description:
    - Name of the load balancing virtual server to which the content is switched.

targetvserverexpr:
    description:
    - Information about this content switching action.

Outputs

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