You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

netscaler_save_config - Save Netscaler configuration.¶

New in version 2.4.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
- Status

Synopsis ¶

This module uncoditionally saves the configuration on the target netscaler node.
This module does not support check mode.
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
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`.
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 ¶

---
- name: Save netscaler configuration
  delegate_to: localhost
  netscaler_save_config:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot

- name: Setup server without saving  configuration
  delegate_to: localhost
  notify: Save configuration
  netscaler_server:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot

    save_config: no

    name: server-1
    ipaddress: 192.168.1.1

# Under playbook's handlers

- name: Save configuration
  delegate_to: localhost
  netscaler_save_config:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot

Return Values ¶

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

name	description	returned	type	sample
loglines	list of logged messages by the module	always	list	['message 1', 'message 2']
msg	Message detailing the failure reason	failure	str	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.