community.general.netscaler_server (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 server entities configuration.

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.

- name: Setup server
  delegate_to: localhost
  netscaler_server:
      nsip: 172.18.0.2
      nitro_user: nsroot
      nitro_pass: nsroot

      state: present

      name: server-1
      ipaddress: 192.168.1.1

Inputs

    
td:
    description:
    - Integer value that uniquely identifies the traffic domain in which you want to configure
      the entity. If you do not specify an ID, the entity becomes part of the default
      traffic domain, which has an ID of 0.
    - Minimum value = C(0)
    - Maximum value = C(4094)

name:
    description:
    - Name for the server.
    - Must begin with an ASCII alphabetic or underscore C(_) character, and must contain
      only ASCII alphanumeric, underscore C(_), hash C(#), period C(.), space C( ), colon
      C(:), at C(@), equals C(=), and hyphen C(-) characters.
    - Can be changed after the name is created.
    - Minimum length = 1

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

delay:
    description:
    - Time, in seconds, after which all the services configured on the server are disabled.
    - This option is meaningful only when setting the I(disabled) option to C(true)

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

domain:
    description:
    - Domain name of the server. For a domain based configuration, you must create the
      server first.
    - Minimum length = 1

comment:
    description:
    - Any information about the server.

disabled:
    default: false
    description:
    - When set to C(true) the server state will be set to C(disabled).
    - When set to C(false) the server state will be set to C(enabled).
    - Note that due to limitations of the underlying NITRO API a C(disabled) state change
      alone does not cause the module result to report a changed status.
    type: bool

graceful:
    description:
    - Shut down gracefully, without accepting any new connections, and disabling each
      service when all of its connections are closed.
    - This option is meaningful only when setting the I(disabled) option to C(true)
    type: bool

ipaddress:
    description:
    - 'IPv4 or IPv6 address of the server. If you create an IP address based server, you
      can specify the name of the server, instead of its IP address, when creating a service.
      Note: If you do not create a server entry, the server IP address that you enter
      when you create a service becomes the name of the server.'

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

ipv6address:
    default: false
    description:
    - Support IPv6 addressing mode. If you configure a server with the IPv6 addressing
      mode, you cannot use the server in the IPv4 addressing mode.
    type: bool

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

translationip:
    description:
    - IP address used to transform the server's DNS-resolved IP address.

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

translationmask:
    description:
    - The netmask of the translation ip.

domainresolveretry:
    default: 5
    description:
    - Time, in seconds, for which the NetScaler appliance must wait, after DNS resolution
      fails, before sending the next DNS query to resolve the domain name.
    - Minimum value = C(5)
    - Maximum value = C(20939)

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