nttmcp / nttmcp.mcp / 1.0.9 / module / vip_pool Create, update and delete VIP Pools | "added in version" 2.10.0 of nttmcp.mcp" Authors: Ken Sinfield (@kensinfield) preview | supported by NTT Ltd.nttmcp.mcp.vip_pool (1.0.9) — module
Install with ansible-galaxy collection install nttmcp.mcp:==1.0.9
collections: - name: nttmcp.mcp version: 1.0.9
Create, update and delete VIP Pools
It is quicker to use the option "id" to locate the VIP Pool 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 Pool vip_pool: region: na datacenter: NA9 network_domain: "my_network_domain" name: "my_pool" description: "Test VIP Pool" health_monitor_1: "CCDEFAULT.Tcp" health_monitor_2: "CCDEFAULT.Http" members: - name: Node_01 port: 443 - name: Node_02 port: 443 state: present - name: Update a specific VIP Pool vip_pool: region: na datacenter: NA9 network_domain: "my_network_domain" name: "my_pool" description: "Test VIP Pool" health_monitor_1: "CCDEFAULT.Tcp" health_monitor_2: "CCDEFAULT.Http" members: - name: Node_01 port: 80 - name: Node_02 port: 443 status: DISABLED state: present - name: Delete a specific VIP Pool Member (To delete Node_02 from above, simply exclude it from the list of member objects) vip_pool: region: na datacenter: NA9 network_domain: "my_network_domain" name: "my_pool" members: - name: Node_01 port: 80 state: present - name: Add a new VIP Pool Member (Node_03) vip_pool: region: na datacenter: NA9 network_domain: "my_network_domain" name: "my_pool" members: - name: Node_01 port: 80 - name: Node_03 port: 80 state: present - name: Delete a specific VIP Pool vip_pool_facts: region: na datacenter: NA9 network_domain: "my_network_domain" name: "my_vip_pool" state: absent
id: description: - The UUID of the VIP Pool. 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 Pool required: false type: str state: choices: - present - absent default: present description: - The action to be performed type: str region: default: na description: - The geographical region required: false type: str members: description: - A list of member objects for this VIP pool elements: dict required: false suboptions: name: description: - The name of the VIP Pool member required: true type: str port: description: - The TCP or UDP port to be used - Specified as an integer required: true type: int type: list datacenter: description: - The datacenter name required: true type: str description: description: - The description for the VIP Pool required: false type: str load_balancing: default: ROUND_ROBIN description: - Defines how the Pool will handle load balancing - A list of supported load balancing methods can be found here - https://docs.mcp-services.net/x/5wMk required: false type: str network_domain: description: - The name of a Cloud Network Domain required: true type: str slow_ramp_time: default: 10 description: - This allows a Server to slowly ramp up connections. - The Slow Ramp Time feature (enabled by default) is used to slowly increase the number of - connection requests that are load balanced to a new Pool Member. - The Slow Ramp Time setting controls the percentage of connections that are sent to a new Pool - Member by specifying the duration (in seconds), that a Pool Member is in slow ramp mode. required: false type: int health_monitor_1: description: - The name of the procedure that the load balancer uses to verify that the Node is considered - healthy and available for load balancing. - A list of supported health monitors can be found here https://docs.mcp-services.net/x/5wMk required: false type: str health_monitor_2: description: - The name of the procedure that the load balancer uses to verify that the Node is considered - healthy and available for load balancing. This cannot be the same value as health_monitor_1 - A list of supported health monitors can be found here https://docs.mcp-services.net/x/5wMk required: false type: str no_health_monitor: default: false description: - If True this will remove all health monitors from the VIP Pool required: false type: bool service_down_action: default: NONE 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. - The Action On Service Down feature specifies how the system should respond to - already-established connections when the target Pool Member becomes unavailable. required: false type: str
data: description: The UUID of the created or updated VIP Pool 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