azure.azcollection.azure_rm_securitygroup module – Manage Azure network security groups
Note
This module is part of the azure.azcollection collection (version 3.0.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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_securitygroup.
New in azure.azcollection 0.1.0
Synopsis
Create, update or delete a network security group.
A security group contains Access Control List (ACL) rules that allow or deny network traffic to subnets or individual network interfaces.
A security group is created with a set of default security rules and an empty set of security rules.
Shape traffic flow by adding rules to the empty set of security rules.
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.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 |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
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:
|
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
The set of default rules automatically added to a security group at creation. In general default rules will not be modified. Modify rules to shape the flow of traffic to or from a subnet or NIC. See rules below for the makeup of a rule dict. |
|
Whether or not to allow the traffic flow. Choices:
|
|
Short description of the rule’s purpose. |
|
The destination address prefix. CIDR or destination IP range. Asterisk Default tags such as It can accept string type or a list of string type. Asterisk Default: |
|
List of the destination application security groups. It could be list of resource id. It could be list of names in same resource group. It could be list of dict containing resource_group and name. It is mutually exclusive with |
|
Port or range of ports to which traffic is headed. It can accept string type or a list of string type. Default: |
|
Indicates the direction of the traffic flow. Choices:
|
|
Unique name for the rule. |
|
Order in which to apply the rule. Must a unique integer between 100 and 4096 inclusive. |
|
Accepted traffic protocol. Choices:
|
|
The CIDR or source IP range. Asterisk Default tags such as If this is an ingress rule, specifies where network traffic originates from. It can accept string type or a list of string type. Asterisk Default: |
|
List of the source application security groups. It could be list of resource id. It could be list of names in same resource group. It could be list of dict containing resource_group and name. It is mutually exclusive with |
|
Port or range of ports from which traffic originates. It can accept string type or a list of string type. Default: |
|
Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the Choices:
|
|
Valid azure location. Defaults to location of the resource group. |
|
Parent argument. |
|
Parent argument. |
|
Name of the security group to operate on. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Remove any existing rules not matching those defined in the default_rules parameter. Choices:
|
|
Remove any existing rules not matching those defined in the rules parameters. Choices:
|
|
Name of the resource group the security group belongs to. |
|
Set of rules shaping traffic flow to or from a subnet or NIC. Each rule is a dictionary. |
|
Whether or not to allow the traffic flow. Choices:
|
|
Short description of the rule’s purpose. |
|
The destination address prefix. CIDR or destination IP range. Asterisk Default tags such as It can accept string type or a list of string type. Asterisk Default: |
|
List of the destination application security groups. It could be list of resource id. It could be list of names in same resource group. It could be list of dict containing resource_group and name. It is mutually exclusive with |
|
Port or range of ports to which traffic is headed. It can accept string type or a list of string type. Default: |
|
Indicates the direction of the traffic flow. Choices:
|
|
Unique name for the rule. |
|
Order in which to apply the rule. Must a unique integer between 100 and 4096 inclusive. |
|
Accepted traffic protocol. Choices:
|
|
The CIDR or source IP range. Asterisk Default tags such as If this is an ingress rule, specifies where network traffic originates from. It can accept string type or a list of string type. Asterisk Default: |
|
List of the source application security groups. It could be list of resource id. It could be list of names in same resource group. It could be list of dict containing resource_group and name. It is mutually exclusive with |
|
Port or range of ports from which traffic originates. It can accept string type or a list of string type. Default: |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Assert the state of the security group. Set to Choices:
|
|
Your Azure subscription Id. |
|
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. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal. |
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 logincommand.
Examples
- name: Create a security group
azure_rm_securitygroup:
resource_group: myResourceGroup
name: mysecgroup
purge_rules: true
rules:
- name: DenySSH
protocol: Tcp
destination_port_range: 22
access: Deny
priority: 100
direction: Inbound
- name: 'AllowSSH'
protocol: Tcp
source_address_prefix:
- '174.109.158.0/24'
- '174.109.159.0/24'
destination_port_range: 22
access: Allow
priority: 101
direction: Inbound
- name: 'AllowMultiplePorts'
protocol: Tcp
source_address_prefix:
- '174.109.158.0/24'
- '174.109.159.0/24'
destination_port_range:
- 80
- 443
access: Allow
priority: 102
- name: Update rules on existing security group
azure_rm_securitygroup:
resource_group: myResourceGroup
name: mysecgroup
rules:
- name: DenySSH
protocol: Tcp
destination_port_range: 22-23
access: Deny
priority: 100
direction: Inbound
- name: AllowSSHFromHome
protocol: Tcp
source_address_prefix: '174.109.158.0/24'
destination_port_range: 22-23
access: Allow
priority: 102
direction: Inbound
tags:
testing: testing
delete: on-exit
- name: Create a securiy group with I(protocol=Icmp)
azure_rm_securitygroup:
name: mysecgroup
resource_group: myResourceGroup
rules:
- name: SSH
protocol: Tcp
destination_port_range: 22
access: Allow
priority: 105
direction: Inbound
- name: ICMP
protocol: Icmp
priority: 106
- name: Delete security group
azure_rm_securitygroup:
resource_group: myResourceGroup
name: mysecgroup
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Current state of the security group. Returned: always |
|
The default security rules of network security group. Returned: always Sample: |
|
The resource ID. Returned: always Sample: |
|
The resource location. Returned: always Sample: |
|
Name of the secrurity group. Returned: always Sample: |
|
A collection of references to network interfaces. Returned: always Sample: |
|
A collection of security rules of the network security group. Returned: always Sample: |
|
A collection of references to subnets. Returned: always Sample: |
|
Tags to assign to the security group. Returned: always Sample: |
|
The resource type. Returned: always Sample: |