You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

azure.azcollection.azure_rm_publicipaddress – Manage Azure Public IP Addresses

Note

This plugin is part of the azure.azcollection collection (version 1.10.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 azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_publicipaddress.

New in version 0.1.0: of azure.azcollection

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis 

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

Requirements 

The below requirements are needed on the host that executes this module.

python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters 

Parameter	Comments
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 0.0.1 of azure.azcollection	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
allocation_method string	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. Choices: dynamic ← (default) static Static Dynamic
api_profile string added in 0.0.1 of azure.azcollection	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack. Default: “latest”
append_tags boolean	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. Choices: no yes ← (default)
auth_source string added in 0.0.1 of azure.azcollection	Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6. Choices: auto ← (default) cli credential_file env msi
cert_validation_mode string added in 0.0.1 of azure.azcollection	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable. Choices: ignore validate
client_id string	Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 0.0.1 of azure.azcollection	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. Default: “AzureCloud”
domain_name aliases: domain_name_label string	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.
idle_timeout integer	Idle timeout in minutes.
ip_tags string	List of IpTag associated with the public IP address. Each element should contain type:value pair.
type string	Sets the ip_tags type.
value string	Sets the ip_tags value.
location string	Valid Azure location. Defaults to location of the resource group.
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	Name of the Public IP.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string / required	Name of resource group with which the Public IP is associated.
secret string	Azure client secret. Use when authenticating with a Service Principal.
sku string	The public IP address SKU. When version=ipv6, if sku=standard then set allocation_method=static. When version=ipv4, if sku=standard then set allocation_method=static. Choices: basic standard Basic Standard
state string	Assert the state of the Public IP. Use `present` to create or update a and `absent` to delete. Choices: absent present ← (default)
subscription_id string	Your Azure subscription Id.
tags dictionary	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. Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag. Azure Front Door doesn’t support the use of Azure Automation and Azure CDN only support 15 tags on resources.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
version string	The public IP address version. Choices: ipv4 ← (default) ipv6

Notes 

Note

For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
Authentication is also 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.

Examples 

- name: Create a public ip address
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    allocation_method: static
    domain_name: foobar

- name: Delete public ip
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    state: absent

Authors

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

There were some errors parsing the documentation for this plugin. Please file a bug with the collection.

The errors were:

Unable to normalize azure_rm_publicipaddress: return due to: 11 validation errors for PluginReturnSchema
return -> state -> contains -> dns_settings -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> etag -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> idle_timeout_in_minutes -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> ip_address -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> location -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> name -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> provisioning_state -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> public_ip_address_version -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> public_ip_allocation_method -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> tags -> returns
  extra fields not permitted (type=value_error.extra)
return -> state -> contains -> type -> returns
  extra fields not permitted (type=value_error.extra)

azure.azcollection.azure_rm_publicipaddress – Manage Azure Public IP Addresses

Synopsis

Requirements

Parameters

Notes

See Also

Examples