netscaler.adc.lbmonitor module – Configuration for monitor resource.

Note

This module is part of the netscaler.adc collection (version 2.6.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.lbmonitor.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for monitor resource.

Parameters

Parameter

Comments

acctapplicationid

any

List of Acct-Application-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring message.

action

any

Action to perform when the response to an inline monitor (a monitor of type HTTP-INLINE) indicates that the service is down. A service monitored by an inline monitor is considered DOWN if the response code is not one of the codes that have been specified for the Response Code parameter.

Available settings function as follows:

* NONE - Do not take any action. However, the show service command and the show lb monitor command indicate the total number of responses that were checked and the number of consecutive error responses received after the last successful probe.

* LOG - Log the event in NSLOG or SYSLOG.

* DOWN - Mark the service as being down, and then do not direct any traffic to the service until the configured down time has expired. Persistent connections to the service are terminated as soon as the service is marked as DOWN. Also, log the event in NSLOG or SYSLOG.

Choices:

  • "NONE"

  • "LOG"

  • "DOWN"

alertretries

any

Number of consecutive probe failures after which the appliance generates an SNMP trap called monProbeFailed.

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

application

string

Name of the application used to determine the state of the service. Applicable to monitors of type CITRIX-XML-SERVICE.

attribute

any

Attribute to evaluate when the LDAP server responds to the query. Success or failure of the monitoring probe depends on whether the attribute exists in the response. Optional.

authapplicationid

any

List of Auth-Application-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring CER message.

basedn

any

The base distinguished name of the LDAP service, from where the LDAP server can begin the search for the attributes in the monitoring query. Required for LDAP service monitoring.

binddn

any

The distinguished name with which an LDAP monitor can perform the Bind operation on the LDAP server. Optional. Applicable to LDAP monitors.

customheaders

any

Custom header string to include in the monitoring probes.

database

any

Name of the database to connect to during authentication.

destip

any

IP address of the service to which to send probes. If the parameter is set to 0, the IP address of the server to which the monitor is bound is considered the destination IP address.

destport

any

TCP or UDP port to which to send the probe. If the parameter is set to 0, the port number of the service to which the monitor is bound is considered the destination port. For a monitor of type USER, however, the destination port is the port number that is included in the HTTP request sent to the dispatcher. Does not apply to monitors of type PING.

deviation

any

Time value added to the learned average response time in dynamic response time monitoring (DRTM). When a deviation is specified, the appliance learns the average response time of bound services and adds the deviation to the average. The final value is then continually adjusted to accommodate response time variations over time. Specified in milliseconds, seconds, or minutes.

dispatcherip

any

IP address of the dispatcher to which to send the probe.

dispatcherport

any

Port number on which the dispatcher listens for the monitoring probe.

domain

any

Domain in which the XenDesktop Desktop Delivery Controller (DDC) servers or Web Interface servers are present. Required by CITRIX-XD-DDC and CITRIX-WI-EXTENDED monitors for logging on to the DDC servers and Web Interface servers, respectively.

downtime

any

Time duration for which to wait before probing a service that has been marked as DOWN. Expressed in milliseconds, seconds, or minutes.

evalrule

string

Expression that evaluates the database server’s response to a MYSQL-ECV or MSSQL-ECV monitoring query. Must produce a Boolean result. The result determines the state of the server. If the expression returns TRUE, the probe succeeds.

For example, if you want the appliance to evaluate the error message to determine the state of the server, use the rule MYSQL.RES.ROW(10) .TEXT_ELEM(2).EQ(“MySQL”).

failureretries

any

Number of retries that must fail, out of the number specified for the Retries parameter, for a service to be marked as DOWN. For example, if the Retries parameter is set to 10 and the Failure Retries parameter is set to 6, out of the ten probes sent, at least six probes must fail if the service is to be marked as DOWN. The default value of 0 means that all the retries must fail if the service is to be marked as DOWN.

filename

any

Name of a file on the FTP server. The appliance monitors the FTP service by periodically checking the existence of the file on the server. Applicable to FTP-EXTENDED monitors.

filter

any

Filter criteria for the LDAP query. Optional.

firmwarerevision

any

Firmware-Revision value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

group

any

Name of a newsgroup available on the NNTP service that is to be monitored. The appliance periodically generates an NNTP query for the name of the newsgroup and evaluates the response. If the newsgroup is found on the server, the service is marked as UP. If the newsgroup does not exist or if the search fails, the service is marked as DOWN. Applicable to NNTP monitors.

grpchealthcheck

any

Option to enable or disable gRPC health check service.

Choices:

  • "YES"

  • "NO"

grpcservicename

any

Option to specify gRPC service name on which gRPC health check need to be performed

grpcstatuscode

any

gRPC status codes for which to mark the service as UP. The default value is 12(health check unimplemented). If the gRPC status code 0 is received from the backend this configuration is ignored.

hostipaddress

any

Host-IP-Address value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. If Host-IP-Address is not specified, the appliance inserts the mapped IP (MIP) address or subnet IP (SNIP) address from which the CER request (the monitoring probe) is sent.

hostname

string

Hostname in the FQDN format (Example: porche.cars.org). Applicable to STOREFRONT monitors.

httprequest

any

HTTP request to send to the server (for example, “HEAD /file.html”).

inbandsecurityid

any

Inband-Security-Id for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

Choices:

  • "NO_INBAND_SECURITY"

  • "TLS"

interval

any

Time interval between two successive probes. Must be greater than the value of Response Time-out.

ipaddress

any

Set of IP addresses expected in the monitoring response from the DNS server, if the record type is A or AAAA. Applicable to DNS monitors.

iptunnel

any

Send the monitoring probe to the service through an IP tunnel. A destination IP address must be specified.

Choices:

  • "YES"

  • "NO"

kcdaccount

any

KCD Account used by MSSQL monitor

lasversion

any

Version number of the Citrix Advanced Access Control Logon Agent. Required by the CITRIX-AAC-LAS monitor.

lbmonitor_metric_binding

dictionary

Bindings for lbmonitor_metric_binding resource

binding_members

list / elements=dictionary

List of binding members

Default: []

mode

string

The mode in which to configure the bindings.

If mode is set to 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 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 unbind, the specified bindings will be removed from the resource. The existing bindings in the target ADCs will not be modified.

Choices:

  • "desired" ← (default)

  • "bind"

  • "unbind"

lbmonitor_sslcertkey_binding

dictionary

Bindings for lbmonitor_sslcertkey_binding resource

binding_members

list / elements=dictionary

List of binding members

Default: []

mode

string

The mode in which to configure the bindings.

If mode is set to 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 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 unbind, the specified bindings will be removed from the resource. The existing bindings in the target ADCs will not be modified.

Choices:

  • "desired" ← (default)

  • "bind"

  • "unbind"

logonpointname

any

Name of the logon point that is configured for the Citrix Access Gateway Advanced Access Control software. Required if you want to monitor the associated login page or Logon Agent. Applicable to CITRIX-AAC-LAS and CITRIX-AAC-LOGINPAGE monitors.

lrtm

any

Calculate the least response times for bound services. If this parameter is not enabled, the appliance does not learn the response times of the bound services. Also used for LRTM load balancing.

Choices:

  • "ENABLED"

  • "DISABLED"

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

maxforwards

any

Maximum number of hops that the SIP request used for monitoring can traverse to reach the server. Applicable only to monitors of type SIP-UDP.

metric

string

Metric name in the metric table, whose setting is changed. A value zero disables the metric and it will not be used for load calculation

metrictable

any

Metric table to which to bind metrics.

metricthreshold

float

Threshold to be used for that metric.

metricweight

float

The weight for the specified service metric with respect to others.

monitorname

any

Name for the monitor. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my monitor” or ‘my monitor’).

mqttclientidentifier

any

Client id to be used in Connect command

mqttversion

any

Version of MQTT protocol used in connect message, default is version 3.1.1 [4]

mssqlprotocolversion

any

Version of MSSQL server that is to be monitored.

Choices:

  • 70

  • 2000

  • "2000SP1"

  • 2005

  • 2008

  • "2008R2"

  • 2012

  • 2014

netprofile

any

Name of the network profile.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

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.

oraclesid

any

Name of the service identifier that is used to connect to the Oracle database during authentication.

originhost

any

Origin-Host value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

originrealm

any

Origin-Realm value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

password

any

Password that is required for logging on to the RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC-ECV or CITRIX-XDM server. Used in conjunction with the user name specified for the User Name parameter.

productname

any

Product-Name value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

query

any

Domain name to resolve as part of monitoring the DNS service (for example, example.com).

querytype

any

Type of DNS record for which to send monitoring queries. Set to Address for querying A records, AAAA for querying AAAA records, and Zone for querying the SOA record.

Choices:

  • "Address"

  • "Zone"

  • "AAAA"

radaccountsession

any

Account Session ID to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

radaccounttype

any

Account Type to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

radapn

any

Called Station Id to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

radframedip

any

Source ip with which the packet will go out . Applicable to monitors of type RADIUS_ACCOUNTING.

radkey

any

Authentication key (shared secret text string) for RADIUS clients and servers to exchange. Applicable to monitors of type RADIUS and RADIUS_ACCOUNTING.

radmsisdn

any

Calling Stations Id to be used in Account Request Packet. Applicable to monitors of type RADIUS_ACCOUNTING.

radnasid

any

NAS-Identifier to send in the Access-Request packet. Applicable to monitors of type RADIUS.

radnasip

any

Network Access Server (NAS) IP address to use as the source IP address when monitoring a RADIUS server. Applicable to monitors of type RADIUS and RADIUS_ACCOUNTING.

recv

any

String expected from the server for the service to be marked as UP. Applicable to TCP-ECV, HTTP-ECV, and UDP-ECV monitors.

respcode

any

Response codes for which to mark the service as UP. For any other response code, the action performed depends on the monitor type. HTTP monitors and RADIUS monitors mark the service as DOWN, while HTTP-INLINE monitors perform the action indicated by the Action parameter.

resptimeout

any

Amount of time for which the appliance must wait before it marks a probe as FAILED. Must be less than the value specified for the Interval parameter.

Note: For UDP-ECV monitors for which a receive string is not configured, response timeout does not apply. For UDP-ECV monitors with no receive string, probe failure is indicated by an ICMP port unreachable error received from the service.

resptimeoutthresh

any

Response time threshold, specified as a percentage of the Response Time-out parameter. If the response to a monitor probe has not arrived when the threshold is reached, the appliance generates an SNMP trap called monRespTimeoutAboveThresh. After the response time returns to a value below the threshold, the appliance generates a monRespTimeoutBelowThresh SNMP trap. For the traps to be generated, the “MONITOR-RTO-THRESHOLD” alarm must also be enabled.

retries

any

Maximum number of probes to send to establish the state of a service for which a monitoring probe failed.

reverse

any

Mark a service as DOWN, instead of UP, when probe criteria are satisfied, and as UP instead of DOWN when probe criteria are not satisfied.

Choices:

  • "YES"

  • "NO"

rtsprequest

any

RTSP request to send to the server (for example, “OPTIONS *”).

save_config

boolean

If 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.

Choices:

  • false ← (default)

  • true

scriptargs

any

String of arguments for the script. The string is copied verbatim into the request.

scriptname

any

Path and name of the script to execute. The script must be available on the Citrix ADC, in the /nsconfig/monitors/ directory.

secondarypassword

any

Secondary password that users might have to provide to log on to the Access Gateway server. Applicable to CITRIX-AG monitors.

secure

any

Use a secure SSL connection when monitoring a service. Applicable only to TCP based monitors. The secure option cannot be used with a CITRIX-AG monitor, because a CITRIX-AG monitor uses a secure connection by default.

Choices:

  • "YES"

  • "NO"

secureargs

any

List of arguments for the script which should be secure

send

any

String to send to the service. Applicable to TCP-ECV, HTTP-ECV, and UDP-ECV monitors.

servicegroupname

string

The name of the service group to which the monitor is to be bound.

servicename

string

The name of the service to which the monitor is bound.

sipmethod

any

SIP method to use for the query. Applicable only to monitors of type SIP-UDP.

Choices:

  • "OPTIONS"

  • "INVITE"

  • "REGISTER"

sipreguri

any

SIP user to be registered. Applicable only if the monitor is of type SIP-UDP and the SIP Method parameter is set to REGISTER.

sipuri

string

SIP URI string to send to the service (for example, sip:sip.test). Applicable only to monitors of type SIP-UDP.

sitepath

string

URL of the logon page. For monitors of type CITRIX-WEB-INTERFACE, to monitor a dynamic page under the site path, terminate the site path with a slash (/). Applicable to CITRIX-WEB-INTERFACE, CITRIX-WI-EXTENDED and CITRIX-XDM monitors.

snmpcommunity

any

Community name for SNMP monitors.

snmpoid

any

SNMP OID for SNMP monitors.

snmpthreshold

any

Threshold for SNMP monitors.

snmpversion

any

SNMP version to be used for SNMP monitors.

Choices:

  • "V1"

  • "V2"

sqlquery

any

SQL query for a MYSQL-ECV or MSSQL-ECV monitor. Sent to the database server after the server authenticates the connection.

sslprofile

any

SSL Profile associated with the monitor

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

When enabled, the resource will be enabled on the NetScaler ADC node.

When disabled, the resource will be disabled on the NetScaler ADC node.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

  • "enabled"

  • "disabled"

  • "unset"

storedb

any

Store the database list populated with the responses to monitor probes. Used in database specific load balancing if MSSQL-ECV/MYSQL-ECV monitor is configured.

Choices:

  • "ENABLED"

  • "DISABLED"

storefrontacctservice

string

Enable/Disable probing for Account Service. Applicable only to Store Front monitors. For multi-tenancy configuration users my skip account service

Choices:

  • "YES"

  • "NO"

storefrontcheckbackendservices

string

This option will enable monitoring of services running on storefront server. Storefront services are monitored by probing to a Windows service that runs on the Storefront server and exposes details of which storefront services are running.

Choices:

  • "YES"

  • "NO"

storename

string

Store Name. For monitors of type STOREFRONT, STORENAME is an optional argument defining storefront service store name. Applicable to STOREFRONT monitors.

successretries

any

Number of consecutive successful probes required to transition a service’s state from DOWN to UP.

supportedvendorids

any

List of Supported-Vendor-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum eight of these AVPs are supported in a monitoring message.

tos

any

Probe the service by encoding the destination IP address in the IP TOS (6) bits.

Choices:

  • "YES"

  • "NO"

tosid

any

The TOS ID of the specified destination IP. Applicable only when the TOS parameter is set.

transparent

any

The monitor is bound to a transparent device such as a firewall or router. The state of a transparent device depends on the responsiveness of the services behind it. If a transparent device is being monitored, a destination IP address must be specified. The probe is sent to the specified IP address by using the MAC address of the transparent device.

Choices:

  • "YES"

  • "NO"

trofscode

any

Code expected when the server is under maintenance

trofsstring

any

String expected from the server for the service to be marked as trofs. Applicable to HTTP-ECV/TCP-ECV monitors.

type

any

Type of monitor that you want to create.

Choices:

  • "PING"

  • "TCP"

  • "HTTP"

  • "TCP-ECV"

  • "HTTP-ECV"

  • "UDP-ECV"

  • "DNS"

  • "FTP"

  • "LDNS-PING"

  • "LDNS-TCP"

  • "LDNS-DNS"

  • "RADIUS"

  • "USER"

  • "HTTP-INLINE"

  • "SIP-UDP"

  • "SIP-TCP"

  • "LOAD"

  • "FTP-EXTENDED"

  • "SMTP"

  • "SNMP"

  • "NNTP"

  • "MYSQL"

  • "MYSQL-ECV"

  • "MSSQL-ECV"

  • "ORACLE-ECV"

  • "LDAP"

  • "POP3"

  • "CITRIX-XML-SERVICE"

  • "CITRIX-WEB-INTERFACE"

  • "DNS-TCP"

  • "RTSP"

  • "ARP"

  • "CITRIX-AG"

  • "CITRIX-AAC-LOGINPAGE"

  • "CITRIX-AAC-LAS"

  • "CITRIX-XD-DDC"

  • "ND6"

  • "CITRIX-WI-EXTENDED"

  • "DIAMETER"

  • "RADIUS_ACCOUNTING"

  • "STOREFRONT"

  • "APPC"

  • "SMPP"

  • "CITRIX-XNC-ECV"

  • "CITRIX-XDM"

  • "CITRIX-STA-SERVICE"

  • "CITRIX-STA-SERVICE-NHOP"

  • "MQTT"

  • "HTTP2"

units1

string

Unit of measurement for the Deviation parameter. Cannot be changed after the monitor is created.

Choices:

  • "SEC"

  • "MSEC"

  • "MIN"

units2

string

Unit of measurement for the Down Time parameter. Cannot be changed after the monitor is created.

Choices:

  • "SEC"

  • "MSEC"

  • "MIN"

units3

string

monitor interval units

Choices:

  • "SEC"

  • "MSEC"

  • "MIN"

units4

string

monitor response timeout units

Choices:

  • "SEC"

  • "MSEC"

  • "MIN"

username

any

User name with which to probe the RADIUS, NNTP, FTP, FTP-EXTENDED, MYSQL, MSSQL, POP3, CITRIX-AG, CITRIX-XD-DDC, CITRIX-WI-EXTENDED, CITRIX-XNC or CITRIX-XDM server.

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

validatecred

any

Validate the credentials of the Xen Desktop DDC server user. Applicable to monitors of type CITRIX-XD-DDC.

Choices:

  • "YES"

  • "NO"

vendorid

any

Vendor-Id value for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers.

vendorspecificacctapplicationids

any

List of Vendor-Specific-Acct-Application-Id attribute value pairs (AVPs) to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring message. The specified value is combined with the value of vendorSpecificVendorId to obtain the Vendor-Specific-Application-Id AVP in the CER monitoring message.

vendorspecificauthapplicationids

any

List of Vendor-Specific-Auth-Application-Id attribute value pairs (AVPs) for the Capabilities-Exchange-Request (CER) message to use for monitoring Diameter servers. A maximum of eight of these AVPs are supported in a monitoring message. The specified value is combined with the value of vendorSpecificVendorId to obtain the Vendor-Specific-Application-Id AVP in the CER monitoring message.

vendorspecificvendorid

any

Vendor-Id to use in the Vendor-Specific-Application-Id grouped attribute-value pair (AVP) in the monitoring CER message. To specify Auth-Application-Id or Acct-Application-Id in Vendor-Specific-Application-Id, use vendorSpecificAuthApplicationIds or vendorSpecificAcctApplicationIds, respectively. Only one Vendor-Id is supported for all the Vendor-Specific-Application-Id AVPs in a CER monitoring message.

Notes

Note

Examples

---
- name: Sample Playbook
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Sample Task | lbmonitor
      delegate_to: localhost
      netscaler.adc.lbmonitor:
        state: present
        monitorname: ldns-dns
        type: LDNS-DNS
        query: .
        querytype: Address
        deviation: '0'
        interval: 6
        resptimeout: 3
        downtime: 20
    - name: Sample Task | lbmonitor | 2
      delegate_to: localhost
      netscaler.adc.lbmonitor:
        state: present
        monitorname: stasecure
        type: CITRIX-STA-SERVICE
        deviation: '0'
        interval: 2
        units3: MIN
        resptimeout: 4
        downtime: 5
    - name: Sample Task | lbmonitor | 3
      delegate_to: localhost
      tags: test
      netscaler.adc.lbmonitor:
        state: present
        monitorname: test-monitor1
        type: TCP
        interval: 15
        retries: 20

Return Values

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

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

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"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)