opentelekomcloud / opentelekomcloud.cloud / 0.6.0 / module / floating_ip Manage floating IP | "added in version" 0.0.1 of opentelekomcloud.cloud" Authors: OpenStack Ansible SIG, forked and changed by Tino Schreiber (@tischrei)opentelekomcloud.cloud.floating_ip (0.6.0) — module
Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.6.0
collections: - name: opentelekomcloud.cloud version: 0.6.0
Add, Allocate or Remove a floating IP
Returns the floating IP parameters
# Allocate floating IP without attaching it to any resource - opentelekomcloud.cloud.floating_ip: cloud: "{{ test_cloud }}" network: admin_external_net server: ecs-tino-test register: fip
# Assign a floating IP to the first interface of `cattle001` from an existing # external network or nova pool. A new floating IP from the first available # external network is allocated to the project. - opentelekomcloud.cloud.floating_ip: cloud: dguerri server: cattle001
# Assign a new floating IP to the instance fixed ip `192.0.2.3` of # `cattle001`. If a free floating IP is already allocated to the project, it is # reused; if not, a new one is created. - opentelekomcloud.cloud.floating_ip: cloud: dguerri state: present reuse: yes server: cattle001 network: ext_net fixed_address: 192.0.2.3 wait: true timeout: 180
# Assign a new floating IP from the network `ext_net` to the instance fixed # ip in network `private_net` of `cattle001`. - opentelekomcloud.cloud.floating_ip: cloud: dguerri state: present server: cattle001 network: ext_net nat_destination: private_net wait: true timeout: 180
# Detach a floating IP address from a server - opentelekomcloud.cloud.floating_ip: cloud: dguerri state: absent floating_ip_address: 203.0.113.2 server: cattle001
auth: description: - Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default I(password) plugin, this would contain I(auth_url), I(username), I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name) or I(os_project_domain_name)) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. type: dict wait: default: 'no' description: - When attaching a floating IP address, specify whether to wait for it to appear as attached. - Must be set to C(yes) for the module to return the value of the floating IP. type: bool cloud: description: - Named cloud or cloud config to operate against. If I(cloud) is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is provided or if OpenStack OS_* environment variables are present. If I(cloud) is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. type: raw purge: default: 'no' description: - When I(state) is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only. type: bool reuse: default: 'no' description: - When I(state) is present, and I(floating_ip_address) is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project. type: bool state: choices: - present - absent default: present description: - Should the resource be present or absent. type: str server: description: - The name or ID of the instance to which the IP address should be assigned. type: str ca_cert: aliases: - cacert description: - A path to a CA Cert bundle that can be used as part of verifying SSL API requests. type: str network: description: - The name or ID of a neutron external network or a nova pool name. type: str timeout: default: 60 description: - Time to wait for an IP address to appear as attached. See wait. required: false type: int auth_type: description: - Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the I(auth) parameter should be updated accordingly. type: str interface: aliases: - endpoint_type choices: - admin - internal - public default: public description: - Endpoint URL type to fetch from the service catalog. type: str client_key: aliases: - key description: - A path to a client key to use as part of the SSL transaction. type: str api_timeout: description: - How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. type: int client_cert: aliases: - cert description: - A path to a client certificate to use as part of the SSL transaction. type: str region_name: description: - Name of the region. type: str fixed_address: description: - To which fixed IP of server the floating IP address should be attached to. type: str validate_certs: aliases: - verify default: false description: - Whether or not SSL API requests should be verified. - Before Ansible 2.3 this defaulted to C(yes). type: bool nat_destination: aliases: - fixed_network - internal_network description: - The name or id of a neutron private network that the fixed IP to attach floating IP is on type: str floating_ip_address: description: - A floating IP address to attach or to detach. Required only if I(state) is absent. When I(state) is present can be used to specify a IP address to attach. type: str
floating_ip: description: Floating IP returned: changed truea sample: floating_ip: attached: true created_at: '2020-10-14T16:16:35' description: '' dns_domain: domain.com. dns_name: ecs-80-158-49-123 fixed_ip_address: 192.168.0.123 floating_ip_address: 80.158.49.123 floating_network_id: 0a2228f2-7f8a-45f1-8e09-9039e1d09123 id: c1d2e3e3-7d21-49c8-a54a-1f68ebf50123 network: 0a2228f2-7f8a-45f1-8e09-9039e1d09123 port: 68a6f030-23d7-4233-b48f-a965318ae123 port_id: 68a6f030-23d7-4233-b48f-a965318ae123 project_id: 16d53a84a13b49529d2e2c3646691123 properties: dns_domain: domain.com. dns_name: ecs-80-158-49-123 revision_number: null router: 26ca2783-dc40-4e3a-95b1-5a0756441123 router_id: 26ca2783-dc40-4e3a-95b1-5a0756441123 status: DOWN tenant_id: 16d53a84a13b49529d2e2c3646691123 updated_at: '2020-10-14T16:16:35' type: dict