New in version 2.1.
The below requirements are needed on the host that executes this module.
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. aliases: address_prefix | |
adfs_authority_url (added in 2.6) | Default: None | 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 latest is appropriate for public clouds; future values will allow use with Azure Stack. |
append_tags bool |
| 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 auto if variable is not defined.auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials .When set to cli , the credentials will be sources from the default Azure CLI profile.Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.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 (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 ignore . Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. |
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, 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 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 name and resource_group of the route_table. | |
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 name and resource_group of the security group.aliases: security_group_name | |
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. aliases: virtual_network |
Note
- 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
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. | ||
id str | Subnet resource path. | |||
address_prefix str | IP address CIDR. | |||
network_security_group complex | | |||
id str | Security group resource identifier. | |||
name str | Name of the security group. | |||
name str | Subnet name. | |||
provisioning_state str | Success or failure of the provisioning event. |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by an Ansible Partner, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 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