azure_rm_subnet – Manage Azure subnets.
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
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 - |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
address_prefix_cidr - / required |
CIDR defining the IPv4 address space of the subnet. Must be valid within the context of the virtual network.
| |
adfs_authority_url - added in 2.6 |
Default: null |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
api_profile - added in 2.5 |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
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. |
auth_source - added in 2.5 |
|
Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to
When set to Can also be set via the When set to The |
cert_validation_mode - added in 2.5 |
|
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 |
client_id - |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment - added in 2.4 |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, |
name - / required |
Name of the subnet. | |
password - |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
profile - |
Security profile found in ~/.azure/credentials file. | |
resource_group - / required |
Name of resource group. | |
route_table - added in 2.7 |
The reference of the RouteTable resource. It can accept both a str or a dict. The str can be the name or resource id of the route table. The dict can contains | |
secret - |
Azure client secret. Use when authenticating with a Service Principal. | |
security_group - |
Existing security group with which to associate the subnet. It can be the security group name which is in the same resource group. It can be the resource Id. It can be a dict which contains
| |
state - |
|
Assert the state of the subnet. Use 'present' to create or update a subnet and 'absent' to delete a subnet. |
subscription_id - |
Your Azure subscription Id. | |
tags - |
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 - |
Azure tenant ID. Use when authenticating with a Service Principal. | |
virtual_network_name - / required |
Name of an existing virtual network with which the subnet is or will be associated.
|
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.
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: Create a subnet refer nsg from other resource group
azure_rm_subnet:
name: foobar
virtual_network_name: My_Virtual_Network
resource_group: Testing
address_prefix_cidr: "10.1.0.0/16"
security_group:
name: secgroupfoo
resource_group: Testing1
route_table: route
- 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, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
state complex |
success |
Current state of the subnet.
| ||
address_prefix string |
IP address CIDR.
| |||
id string |
Subnet resource path.
| |||
name string |
Subnet name.
| |||
network_security_group complex |
||||
id string |
Security group resource identifier.
| |||
name string |
Name of the security group.
| |||
provisioning_state string |
Success or failure of the provisioning event.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/azure_rm_subnet_module.html