+ netscaler.adc.save_config module – Login to a NetScaler ADC node.
+Note
+This module is part of the netscaler.adc collection (version 2.2.0).
+It is not included in ansible-core.
+To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netscaler.adc.
To use it in a playbook, specify: netscaler.adc.save_config.
New in netscaler.adc 2.2.0
+ +Synopsis
+-
+
Configuration for logging in to a NetScaler ADC node.
+
Parameters
+Parameter |
+Comments |
+
|---|---|
| + | Use this option to do saveconfig for all partitions +Choices: +
|
+
| + | Base NITRO API path. +Define only in case of an ADM service proxy call +Default: |
+
| + | The authentication token provided by a login operation. + |
+
| + | The password with which to authenticate to the NetScaler ADC node. + |
+
| + | Which protocol to use when accessing the nitro API objects. +Choices: +
|
+
| + | The username with which to authenticate to the NetScaler ADC node. + |
+
| + | The ip address of the NetScaler ADC appliance where the nitro API calls will be made. +The port can be specified with the colon (:). E.g. 192.168.1.1:555. + |
+
| + | If The module will not save the configuration on the NetScaler ADC node if it made no changes. +Choices: +
|
+
| + | The state of the resource being configured by the module on the NetScaler ADC node. +When Choices: +
|
+
| + | If Choices: +
|
+
Notes
+Note
+-
+
For more information on using Ansible to manage NetScaler ADC Network devices see https://www.ansible.com/integrations/networks/citrixadc.
+
Examples
+---
+- name: Sample save config
+ hosts: demo_netscalers
+
+ gather_facts: false
+
+ tasks:
+ - name: V2 | Sample Task | Save config
+ delegate_to: localhost
+ netscaler.adc.save_config:
+ # nsip: 10.0.0.1 # This can also be given via NETSCALER_NSIP environment variable
+ # nitro_protocol: https # This can also be given via NETSCALER_NITRO_PROTOCOL environment variable
+ # validate_certs: false # This can also be given via NETSCALER_VALIDATE_CERTS environment variable
+ # save_config: false # This can also be given via NETSCALER_SAVE_CONFIG environment variable
+
+
+ - name: V2 | Sample Task | Save config for all partitions
+ delegate_to: localhost
+ netscaler.adc.save_config:
+ # nsip: 10.0.0.1 # This can also be given via NETSCALER_NSIP environment variable
+ # nitro_protocol: https # This can also be given via NETSCALER_NITRO_PROTOCOL environment variable
+ # validate_certs: false # This can also be given via NETSCALER_VALIDATE_CERTS environment variable
+ # save_config: false # This can also be given via NETSCALER_SAVE_CONFIG environment variable
+ all: true
+Return Values
+Common return values are documented here, the following are the fields unique to this module:
+Key |
+Description |
+
|---|---|
| + | Indicates if any change is made by the module. `save_config` module always returns `true` unless it fails. +Returned: always +Sample: |
+
| + | Indicates if the module failed or not +Returned: always +Sample: |
+
| + | list of logged messages by the module +Returned: always +Sample: |
+