Try SpotterConfiguration for system group resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for system group resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | systemgroup
delegate_to: localhost
netscaler.adc.systemgroup:
state: present
groupname: sys-group1
promptstring: '[%T] %u@%h/%s'
nsip:
description:
- 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.
required: true
type: str
state:
choices:
- present
- absent
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(absent), the resource will be deleted from the NetScaler ADC node.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
timeout:
description:
- CLI session inactivity timeout, in seconds. If Restrictedtimeout argument of system
parameter is enabled, Timeout can have values in the range [300-86400] seconds.If
Restrictedtimeout argument of system parameter is disabled, Timeout can have values
in the range [0, 10-100000000] seconds. Default value is 900 seconds.
type: float
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
groupname:
description:
- Name for the group. Must begin with a letter, number, hash(#) or the underscore
(_) character, and must contain only alphanumeric, hyphen (-), period (.), hash
(#), space ( ), at (@), equal (=), colon (:), and underscore characters. Cannot
be changed after the group is created.
- ''
- 'CLI Users: If the name includes one or more spaces, enclose the name in double
or single quotation marks (for example, "my group" or ''my group'').'
type: str
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
save_config:
default: false
description:
- If C(true) the module will save the configuration on the NetScaler ADC node if it
makes any changes.
- The module will not save the configuration on the NetScaler ADC node if it made
no changes.
type: bool
promptstring:
description:
- 'String to display at the command-line prompt. Can consist of letters, numbers,
hyphen (-), period (.), hash (#), space ( ), at (@), equal (=), colon (:), underscore
(_), and the following variables:'
- '* %u - Will be replaced by the user name.'
- '* %h - Will be replaced by the hostname of the Citrix ADC.'
- '* %t - Will be replaced by the current time in 12-hour format.'
- '* %T - Will be replaced by the current time in 24-hour format.'
- '* %d - Will be replaced by the current date.'
- '* %s - Will be replaced by the state of the Citrix ADC.'
- ''
- 'Note: The 63-character limit for the length of the string does not apply to the
characters that replace the variables.'
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
allowedmanagementinterface:
choices:
- CLI
- API
description:
- Allowed Management interfaces of the system users in the group. By default allowed
from both C(API) and C(CLI) interfaces. If management interface for a group is set
to C(API), then all users under this group will not allowed to access NS through
C(CLI). GUI interface will come under C(API) interface
elements: str
type: list
systemgroup_systemuser_binding:
description: Bindings for systemgroup_systemuser_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
systemgroup_nspartition_binding:
description: Bindings for systemgroup_nspartition_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
systemgroup_systemcmdpolicy_binding:
description: Bindings for systemgroup_systemcmdpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: List of differences between the actual configured object and the configuration
specified in the module
returned: when changed
sample:
- 'Attribute `key1` differs. Desired: (<class ''str''>) XYZ. Existing: (<class ''str''>)
PQR'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list