Documentation

azure_rm_subnet - Manage Azure subnets.

New in version 2.1.

Synopsis

  • Create, update or delete a subnet within a given virtual network. Allows setting and updating the address prefix CIDR, which must be valid within the context of the virtual network. Use the azure_rm_networkinterface module to associate interfaces with the subnet and assign specific IP addresses.

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.
address_prefix_cidr
 yes
CIDR defining the IPv4 address space of the subnet. Must be valid within the context of the virtual network.

aliases: address_prefix
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.
name
 yes
Name of the subnet.
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.
secret
 no
Azure client secret. Use when authenticating with a Service Principal.
security_group_name
 no
Name of an existing security group with which to associate the subnet.

aliases: security_group
state
 no present
  • absent
  • present
Assert the state of the subnet. Use 'present' to create or update a subnet and 'absent' to delete a subnet.
subscription_id
 no
Your Azure subscription Id.
tenant
 no
Azure tenant ID. Use when authenticating with a Service Principal.
virtual_network_name
 yes
Name of an existing virtual network with which the subnet is or will be associated.

aliases: virtual_network

Examples

- name: Create a subnet
  azure_rm_subnet:
    name: foobar
    virtual_network_name: My_Virtual_Network
    resource_group: Testing
    address_prefix_cidr: "10.1.0.0/24"

- name: Delete a subnet
  azure_rm_subnet:
    name: foobar
    virtual_network_name: My_Virtual_Network
    resource_group: Testing
    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
Current state of the subnet.
 success complex
contains:
name description returned type sample
id
Subnet resource path.
 str
address_prefix
IP address CIDR.
 str
network_security_group complex
name
Subnet name.
 str
provisioning_state
Success or failure of the provisioning event.
 str


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.