Class: Ansible::Ruby::Modules::Netscaler_gslb_site

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb

Overview

Manage gslb site entities in Netscaler.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#clipObject?

Returns Cluster IP address. Specify this parameter to connect to the remote cluster site for GSLB auto-sync. Note: The cluster IP address is defined when creating the cluster.

Returns:

  • (Object, nil)

    Cluster IP address. Specify this parameter to connect to the remote cluster site for GSLB auto-sync. Note: The cluster IP address is defined when creating the cluster.



47
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 47

attribute :clip

#metricexchange:enabled, ...

Returns Exchange metrics with other sites. Metrics are exchanged by using Metric Exchange Protocol (MEP). The appliances in the GSLB setup exchange health information once every second.,If you disable metrics exchange, you can use only static load balancing methods (such as round robin, static proximity, or the hash-based methods), and if you disable metrics exchange when a dynamic load balancing method (such as least connection) is in operation, the appliance falls back to round robin. Also, if you disable metrics exchange, you must use a monitor to determine the state of GSLB services. Otherwise, the service is marked as DOWN.

Returns:

  • (:enabled, :disabled, nil)

    Exchange metrics with other sites. Metrics are exchanged by using Metric Exchange Protocol (MEP). The appliances in the GSLB setup exchange health information once every second.,If you disable metrics exchange, you can use only static load balancing methods (such as round robin, static proximity, or the hash-based methods), and if you disable metrics exchange when a dynamic load balancing method (such as least connection) is in operation, the appliance falls back to round robin. Also, if you disable metrics exchange, you must use a monitor to determine the state of GSLB services. Otherwise, the service is marked as DOWN.



28
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 28

attribute :metricexchange

#naptrreplacementsuffixObject?

Returns The naptr replacement suffix configured here will be used to construct the naptr replacement field in NAPTR record.,Minimum length = 1.

Returns:

  • (Object, nil)

    The naptr replacement suffix configured here will be used to construct the naptr replacement field in NAPTR record.,Minimum length = 1



53
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 53

attribute :naptrreplacementsuffix

#nwmetricexchange:enabled, ...

Returns Exchange, with other GSLB sites, network metrics such as round-trip time (RTT), learned from communications with various local DNS (LDNS) servers used by clients. RTT information is used in the dynamic RTT load balancing method, and is exchanged every 5 seconds.

Returns:

  • (:enabled, :disabled, nil)

    Exchange, with other GSLB sites, network metrics such as round-trip time (RTT), learned from communications with various local DNS (LDNS) servers used by clients. RTT information is used in the dynamic RTT load balancing method, and is exchanged every 5 seconds.



32
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 32

attribute :nwmetricexchange

#parentsiteObject?

Returns Parent site of the GSLB site, in a parent-child topology.

Returns:

  • (Object, nil)

    Parent site of the GSLB site, in a parent-child topology.



44
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 44

attribute :parentsite

#publicclipObject?

Returns IP address to be used to globally access the remote cluster when it is deployed behind a NAT. It can be same as the normal cluster IP address.

Returns:

  • (Object, nil)

    IP address to be used to globally access the remote cluster when it is deployed behind a NAT. It can be same as the normal cluster IP address.



50
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 50

attribute :publicclip

#publicipString?

Returns Public IP address for the local site. Required only if the appliance is deployed in a private address space and the site has a public IP address hosted on an external firewall or a NAT device.,Minimum length = 1.

Returns:

  • (String, nil)

    Public IP address for the local site. Required only if the appliance is deployed in a private address space and the site has a public IP address hosted on an external firewall or a NAT device.,Minimum length = 1



24
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 24

attribute :publicip

#sessionexchange:enabled, ...

Returns Exchange persistent session entries with other GSLB sites every five seconds.

Returns:

  • (:enabled, :disabled, nil)

    Exchange persistent session entries with other GSLB sites every five seconds.



36
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 36

attribute :sessionexchange

#siteipaddressString?

Returns IP address for the GSLB site. The GSLB site uses this IP address to communicate with other GSLB sites. For a local site, use any IP address that is owned by the appliance (for example, a SNIP or MIP address, or the IP address of the ADNS service).,Minimum length = 1.

Returns:

  • (String, nil)

    IP address for the GSLB site. The GSLB site uses this IP address to communicate with other GSLB sites. For a local site, use any IP address that is owned by the appliance (for example, a SNIP or MIP address, or the IP address of the ADNS service).,Minimum length = 1



20
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 20

attribute :siteipaddress

#sitenameString?

Returns Name for the GSLB site. Must begin with an ASCII alphanumeric 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. Cannot be changed after the virtual server is created.,Minimum length = 1.

Returns:

  • (String, nil)

    Name for the GSLB site. Must begin with an ASCII alphanumeric 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. Cannot be changed after the virtual server is created.,Minimum length = 1



12
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 12

attribute :sitename

#sitetype:REMOTE, ...

Returns Type of site to create. If the type is not specified, the appliance automatically detects and sets the type on the basis of the IP address being assigned to the site. If the specified site IP address is owned by the appliance (for example, a MIP address or SNIP address), the site is a local site. Otherwise, it is a remote site.

Returns:

  • (:REMOTE, :LOCAL, nil)

    Type of site to create. If the type is not specified, the appliance automatically detects and sets the type on the basis of the IP address being assigned to the site. If the specified site IP address is owned by the appliance (for example, a MIP address or SNIP address), the site is a local site. Otherwise, it is a remote site.



16
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 16

attribute :sitetype

#triggermonitor:ALWAYS, ...

Returns Specify the conditions under which the GSLB service must be monitored by a monitor, if one is bound. Available settings function as follows:,* C(ALWAYS) - Monitor the GSLB service at all times.,* C(MEPDOWN) - Monitor the GSLB service only when the exchange of metrics through the Metrics Exchange Protocol (MEP) is disabled.,C(MEPDOWN_SVCDOWN) - Monitor the service in either of the following situations:,* The exchange of metrics through MEP is disabled.,* The exchange of metrics through MEP is enabled but the status of the service, learned through metrics exchange, is DOWN.

Returns:

  • (:ALWAYS, :MEPDOWN, :MEPDOWN_SVCDOWN, nil)

    Specify the conditions under which the GSLB service must be monitored by a monitor, if one is bound. Available settings function as follows:,* C(ALWAYS) - Monitor the GSLB service at all times.,* C(MEPDOWN) - Monitor the GSLB service only when the exchange of metrics through the Metrics Exchange Protocol (MEP) is disabled.,C(MEPDOWN_SVCDOWN) - Monitor the service in either of the following situations:,* The exchange of metrics through MEP is disabled.,* The exchange of metrics through MEP is enabled but the status of the service, learned through metrics exchange, is DOWN.



40
# File 'lib/ansible/ruby/modules/generated/network/netscaler/netscaler_gslb_site.rb', line 40

attribute :triggermonitor