Documentation

cs_instance_nic_secondaryip - Manages secondary IPs of an instance on Apache CloudStack based clouds.

New in version 2.4.

Synopsis

  • Add and remove secondary IPs to and from a NIC of an instance.

Options

parameter required default choices comments
account
 no
Account the instance is related to.
api_http_method
 no get
  • get
  • post
HTTP method used.
api_key
 no
API key of the CloudStack API.
api_region
 no cloudstack
Name of the ini section in the cloustack.ini file.
api_secret
 no
Secret key of the CloudStack API.
api_timeout
 no 10
HTTP timeout.
api_url
 no
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
domain
 no
Domain the instance is related to.
network
 no
Name of the network.
Required to find the NIC if instance has multiple networks assigned.
poll_async
 no True
Poll async jobs until job has finished.
project
 no
Name of the project the instance is deployed in.
state
 no present
  • present
  • absent
State of the ipaddress.
vm
 yes
Name of instance.

aliases: name
vm_guest_ip
 no
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.

aliases: secondary_ip
vpc
 no
Name of the VPC the vm is related to.
zone
 no
Name of the zone in which the instance is deployed in.
If not set, default zone is used.

Examples

- name: Assign a specific IP to the default NIC of the VM
  local_action:
    module: cs_instance_nic_secondaryip
    vm: customer_xy
    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
  local_action:
    module: cs_instance_nic_secondaryip
    vm: customer_xy

- name: Remove a specific IP from the default NIC
  local_action:
    module: cs_instance_nic_secondaryip
    vm: customer_xy
    vm_guest_ip: 10.10.10.10
    state: absent

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
vm_guest_ip
Secondary IP of the NIC.
 success string 10.10.10.10
domain
Domain the VM is related to.
 success string example domain
network
Name of the network if not default.
 success string sync network
vm
Name of the VM.
 success string web-01
project
Name of project the VM is related to.
 success string Production
netmask
Netmask of the NIC.
 success string 255.255.255.0
mac_address
MAC address of the NIC.
 success string 02:00:33:31:00:e4
account
Account the VM is related to.
 success string example account
ip_address
Primary IP of the NIC.
 success string 10.10.10.10
id
UUID of the NIC.
 success string 87b1e0ce-4e01-11e4-bb66-0050569e64b8


Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. - The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. - A CLOUDSTACK_CONFIG environment variable pointing to an .ini file, - A cloudstack.ini file in the current working directory. - A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
  • A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
  • This module supports check mode.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.