W3cubDocs

/Ansible 2.10

azure.azcollection.azure_rm_publicipaddress – Manage Azure Public IP Addresses

Note

This plugin is part of the azure.azcollection collection.

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

  • 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

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

  • python >= 2.7
  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults 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
    Choices:
  • dynamic ←
  • static
  • Static
  • Dynamic
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.
api_profile
string
added in 0.0.1 of azure.azcollection
Default:
"latest"
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.
append_tags
boolean
    Choices:
  • no
  • yes ←
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.
auth_source
string
added in 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
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.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    Choices:
  • ignore
  • validate
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.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of azure.azcollection
Default:
"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
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.

aliases: domain_name_label
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.
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
    Choices:
  • basic
  • standard
  • Basic
  • Standard
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.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the Public IP. Use present to create or update a and absent to delete.
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.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
version
string
    Choices:
  • ipv4 ←
  • ipv6
The public IP address version.

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.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

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)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_publicipaddress_module.html