W3cubDocs

/Ansible

azure_rm_publicipaddress - Manage Azure Public IP Addresses.

New in version 2.1.

Synopsis

  • Create, update and delete a Public IP address. Allows setting and updating the address allocation method and domain name label. Use the azure_rm_networkinterface module to associate a Public IP with a network interface.

Requirements (on host that executes module)

  • python >= 2.7
  • azure >= 2.0.0

Options

parameter required default choices comments
ad_user
 no
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
allocation_method
 no Dynamic
  • Dynamic
  • Static
Control whether the assigned Public IP remains permanently assigned to the object. If not set to 'Static', the IP address my changed anytime an associated virtual machine is power cycled.
append_tags
 no True
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
client_id
 no
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
 no AzureCloud
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
domain_name_label
 no
The customizable portion of the FQDN assigned to public IP address. This is an explicit setting. If no value is provided, any existing value will be removed on an existing public IP.
aliases: domain_name_label
location
 no resource_group location
Valid azure location. Defaults to location of the resource group.
name
 yes
Name of the Public IP.
password
 no
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
 no
Security profile found in ~/.azure/credentials file.
resource_group
 yes
Name of resource group with which the Public IP is associated.
secret
 no
Azure client secret. Use when authenticating with a Service Principal.
state
 no present
  • absent
  • present
Assert the state of the Public IP. Use 'present' to create or update a and 'absent' to delete.
subscription_id
 no
Your Azure subscription Id.
tags
 no
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
tenant
 no
Azure tenant ID. Use when authenticating with a Service Principal.

Examples

- name: Create a public ip address
  azure_rm_publicipaddress:
    resource_group: testing
    name: my_public_ip
    allocation_method: Static
    domain_name: foobar

- name: Delete public ip
  azure_rm_publicipaddress:
    resource_group: testing
    name: my_public_ip
    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
state
Facts about the current state of the object.
 always dict {'dns_settings': {}, 'name': 'publicip002', 'tags': {}, 'public_ip_allocation_method': 'Static', 'provisioning_state': 'Succeeded', 'ip_address': '52.160.103.93', 'etag': '"/"a5e56955-12df-445a-bda4-dc129d22c12f"', 'location': 'westus', 'idle_timeout_in_minutes': 4, 'type': 'Microsoft.Network/publicIPAddresses'}

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

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.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/azure_rm_publicipaddress_module.html