nttmcp / nttmcp.mcp / 1.0.9 / module / vip_listener_info List/Get VIP Virtual Listeners | "added in version" 2.10.0 of nttmcp.mcp" Authors: Ken Sinfield (@kensinfield) preview | supported by NTT Ltd.nttmcp.mcp.vip_listener_info (1.0.9) — module
Install with ansible-galaxy collection install nttmcp.mcp:==1.0.9
collections: - name: nttmcp.mcp version: 1.0.9
List/Get VIP Virtual Listeners
It is quicker to use the option "id" to locate the VIP Virtual Listener if the UUID is known
rather than search by name
- hosts: 127.0.0.1 connection: local collections: - nttmcp.mcp tasks: - name: List All VIP Virtual Listener vip_listener_info: region: na datacenter: NA9 network_domain: my_network_domain - name: Get a specific VIP Virtual Listener by name vip_listener_info: region: na datacenter: NA9 network_domain: my_network_domain name: my_listener - name: Get a specific VIP Virtual Listener by ID vip_listener_info: region: na datacenter: NA9 network_domain: my_network_domain id: 56cfa8ec-c178-47ff-98fd-b5580ca33778
id: description: - The UUID of the VIP Virtual Listener required: false type: str auth: description: - Optional dictionary containing the authentication and API information for Cloud Control required: false suboptions: api: description: - The Cloud Control API endpoint e.g. api-na.mcp-services.net required: false type: str api_version: description: - The Cloud Control API version e.g. 2.11 required: false type: str password: description: - The Cloud Control API user password required: false type: str username: description: - The Cloud Control API username required: false type: str type: dict name: description: - The name of the VIP Virtual Listener required: false type: str region: default: na description: - The geographical region required: false type: str datacenter: description: - The datacenter name required: true type: str network_domain: description: - The name of a Cloud Network Domain required: true type: str
data: contains: count: description: The number of objects returned returned: success sample: 1 type: int vip_listener: contains: connectionLimit: description: - The maximum number of simultaneous connections permitted on the Node. - Should be an integer between 1 and 100,000 sample: 100000 type: int connectionRateLimit: description: - The amount of new connections permitted every second. Should be an - integer between 1 and 4,000. sample: 4000 type: int createTime: description: The creation date of the Virtual Listener sample: '2019-01-14T11:12:31.000Z' type: str datacenterId: description: The MCP ID sample: NA9 type: str description: description: The description for the Virtual Listener sample: My Virtual Listener type: str enabled: description: Should the Virtual Listener be enabled type: bool fallbackPersistenceProfile: contains: id: description: The UUID of the persistence profile sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str name: description: The name of the persistence profile sample: CCDEFAULT.Tcp type: str description: The secondary persistence profile type: complex id: description: The UUID of the Virtual Listener sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str irule: contains: id: description: The UUID of the irule sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str name: description: The name of the irule sample: CCDEFAULT.IpProtocolTimers type: str description: - Custom configured rules that are applied to Virtual Servers to perform a wide - array of actions. type: list listenerIpAddress: description: The IPv4 address the Virtual Listener is configured to listen on sample: 10.0.0.10 type: str listenerIpAddressability: description: Is the Virtual Listener a public or private IPv4 address sample: PRIVATE_RFC1918 type: str name: description: The name of the Virtual Listener sample: my_listener type: str networkDomainId: description: The UUID of the Cloud Network Domain sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str optimizationProfile: description: - For certain combinations of Virtual Listener type and protocol, - it is possible to specify an additional optimization profile. sample: TCP type: str persistenceProfile: contains: id: description: The UUID of the persistence profile sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str name: description: The name of the persistence profile sample: CCDEFAULT.SourceAddress type: str description: - Provides a method for ensuring that traffic from a client is sent to the same - server in a pool based on an attribute of the connection. type: complex pool: contains: healthMonitor: contains: id: description: The UUID of the Health Monitor sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str name: description: The Health Monitor display name sample: CCDEFAULT.Tcp type: str description: - The procedure that the load balancer uses to verify that the VIP Pool is - considered healthy and available for load balancing type: complex id: description: The UUID of the VIP Pool sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str loadBalanceMethod: description: Defines how the Pool will handle load balancing sample: Round Robin type: str name: description: The VIP Pool display name sample: my_pool type: str serviceDownAction: description: - When a Pool Member fails to respond to a Health Monitor, the system marks - that Pool Member down and removes any persistence entries associated with - the Pool Member sample: RESELECT type: str slowRampTime: description: This allows a Server to slowly ramp up connection sample: 10 type: int description: dict containing the VIP Pool type: complex protocol: description: Which protocol will be associated with the Virtual Listener sample: TCP type: str sourcePortPreservation: description: - Identifies how the port of the source traffic will be treated when sending - connections to the pool member. sample: Preserve type: str sslOffloadProfile: contains: id: description: The UUID of the SSL Offload Profile sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str name: description: The name of the SSL Offload Profile sample: my_ssl_profile type: str description: The SSL Offload Profile associated with this Virtual Listener (if any) type: complex state: description: The operation state of the Virtual Listener sample: NORMAL type: str type: description: - The virtual listener type is used to both specify how the load balancer should handle - traffic and what features/options can be assigned. sample: Standard type: str description: VIP Virtual Listener returned: success type: complex description: dict of returned Objects returned: success type: complex