ngine_io.cloudstack.cs_instance_nic_secondaryip module – Manages secondary IPs of an instance on Apache CloudStack based clouds.
Note
This module is part of the ngine_io.cloudstack collection (version 2.4.0).
You might already have this collection installed if you are using the ansible
package.
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 ngine_io.cloudstack
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ngine_io.cloudstack.cs_instance_nic_secondaryip
.
New in ngine_io.cloudstack 0.1.0
Synopsis
Add and remove secondary IPs to and from a NIC of an instance.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.9.0
Parameters
Parameter |
Comments |
---|---|
Account the instance is related to. |
|
HTTP method used to query the API endpoint. If not given, the Choices:
|
|
API key of the CloudStack API. If not given, the |
|
Secret key of the CloudStack API. If not set, the |
|
HTTP timeout in seconds. If not given, the Default: |
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the |
|
Verify CA authority cert file. If not given, the |
|
Domain the instance is related to. |
|
Name of the network. Required to find the NIC if instance has multiple networks assigned. |
|
Poll async jobs until job has finished. Choices:
|
|
Name of the project the instance is deployed in. |
|
State of the ipaddress. Choices:
|
|
If If not given, the This should only be used on personally controlled sites using self-signed certificates. Choices:
|
|
Name of instance. |
|
Secondary IP address to be added to the instance nic. If not set, the API always returns a new IP address and idempotency is not given. |
|
Name of the VPC the vm is related to. |
|
Name of the zone in which the instance is deployed in. |
Notes
Note
A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.
Examples
- name: Assign a specific IP to the default NIC of the VM
ngine_io.cloudstack.cs_instance_nic_secondaryip:
vm: customer_xy
zone: zone01
vm_guest_ip: 10.10.10.10
# Note: If vm_guest_ip is not set, you will get a new IP address on every run.
- name: Assign an IP to the default NIC of the VM
ngine_io.cloudstack.cs_instance_nic_secondaryip:
vm: customer_xy
zone: zone01
- name: Remove a specific IP from the default NIC
ngine_io.cloudstack.cs_instance_nic_secondaryip:
vm: customer_xy
zone: zone01
vm_guest_ip: 10.10.10.10
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Account the VM is related to. Returned: success Sample: |
|
Domain the VM is related to. Returned: success Sample: |
|
UUID of the NIC. Returned: success Sample: |
|
Primary IP of the NIC. Returned: success Sample: |
|
MAC address of the NIC. Returned: success Sample: |
|
Netmask of the NIC. Returned: success Sample: |
|
Name of the network if not default. Returned: success Sample: |
|
Name of project the VM is related to. Returned: success Sample: |
|
Name of the VM. Returned: success Sample: |
|
Secondary IP of the NIC. Returned: success Sample: |