Try SpotterCreate, update and delete VIP Virtual Listeners
| "added in version" 2.10.0 of nttmcp.mcp"
Authors: Ken Sinfield (@kensinfield)
preview | supported by NTT Ltd.
Install with ansible-galaxy collection install nttmcp.mcp:==1.0.9
collections:
- name: nttmcp.mcp
version: 1.0.9Create, update and delete VIP Virtual Listeners
It is quicker to use the option "id" to locate the VIP Listener if the UUID is known rather than search by name
- hosts: 127.0.0.1
connection: local
collections:
- nttmcp.mcp
tasks:
- name: Create a VIP Listener
vip_listener:
region: na
datacenter: NA9
network_domain: "my_network_domain"
name: "my_vip_listener"
description: "My VIP Listener"
ip_address: "10.0.0.10"
protocol: "TCP"
port: 443
pool: "my_pool"
connection_limit: 60000
connection_rate_limit: 3000
persistence_profile: "CCDEFAULT.SourceAddress"
fallback_persistence_profile: "CCDEFAULT.DestinationAddress"
optimization_profile: "TCP"
irules:
- name: CCDEFAULT.IpProtocolTimers
ssl_offload_profile: "my_ssl_profile"
state: present
- name: Update a specific VIP Listener - Remove the fallback persistence profile and irules from the example above
vip_listener:
region: na
datacenter: NA9
network_domain: "my_network_domain"
name: "my_vip_listener"
description: "My VIP Listener"
ip_address: "10.0.0.10"
protocol: "TCP"
port: 443
pool: "my_pool"
connection_limit: 60000
connection_rate_limit: 3000
persistence_profile: "CCDEFAULT.SourceAddress"
optimization_profile: "TCP"
ssl_offload_profile: "my_ssl_profile"
state: present
- name: Delete a specific VIP Pool by name
vip_listener:
region: na
datacenter: NA9
network_domain: "my_network_domain"
name: "my_vip_listener"
state: absent
- name: Delete a specific VIP Pool by id
vip_listener:
region: na
datacenter: NA9
network_domain: "my_network_domain"
id: "b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae"
state: absent
id:
description:
- The UUID of the VIP Listener. Takes precendence over name
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 Listener
required: false
type: str
pool:
description:
- The name of a VIP Pool
required: false
type: str
port:
default: null
description:
- The port to use for the VIP Listener
- If port is excluded or None the listener will be created for ANY port
required: false
type: int
type:
choices:
- STANDARD
- PERFORMANCE_LAYER_4
default: STANDARD
description:
- The type of VIP Listener
required: false
type: str
state:
choices:
- present
- absent
default: present
description:
- The action to be performed
required: false
type: str
irules:
description:
- A list of iRule names
- Custom configured rules that are applied to Virtual Servers to perform a wide array
of
- actions.
elements: str
required: false
type: list
region:
default: na
description:
- The geographical region
required: false
type: str
enabled:
default: true
description:
- Enable/Disable a VIP Listener
required: false
type: bool
protocol:
default: ANY
description:
- The service protocol for the VIP Listener
required: false
type: str
datacenter:
description:
- The datacenter name
required: true
type: str
ip_address:
description:
- The IPv4 address to listen on
required: false
type: str
client_pool:
description:
- The name of an optional client VIP Pool
required: false
type: str
description:
description:
- The description for the VIP Listener
required: false
type: str
preservation:
choices:
- PRESERVE
- PRESERVE_STRICT
default: PRESERVE
description:
- The amount of new connections permitted every second. Should be an integer between
1 and 4,000.
required: false
type: str
network_domain:
description:
- The name of a Cloud Network Domain
required: true
type: str
connection_limit:
default: 100000
description: -The maximum number of simultaneous connections permitted on the Node.
Should be an integer between 1 and 100,000
required: false
type: int
persistence_profile:
description:
- The name of a Persistence Profile
- 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. Each is a set of parameters that optimize
- the handling of traffic based on application type and network protocol.
required: false
type: str
ssl_offload_profile:
description:
- The name of an SSL Offload Profile
- SSL Offloading allows you to set up proxies for SSL certificates at the Virtual
Listener
- level rather than having to set up SSL certificates on individual virtual servers.
required: false
type: str
optimization_profile:
description:
- The name of a Optimization Profile
- For certain combinations of Virtual Listener type and protocol, it is possible to
specify an
- additional optimization profile.
required: false
type: str
connection_rate_limit:
default: 4000
description:
- The amount of new connections permitted every second. Should be an integer between
1 and 4,000.
required: false
type: int
fallback_persistence_profile:
description:
- The name of a Persistence Profile - cannot be the same as the primary Persistence
Profile
- Fallback Persistence is used when the primary Persistence Profile fails
required: false
type: str
data: description: The UUID of the created or updated VIP Listener Object returned: when state == present sample: b2fbd7e6-ddbb-4eb6-a2dd-ad048bc5b9ae type: str msg: description: A useful message returned: when state == absent sample: The object was successfully deleted type: str