Datasets:

vikp
/

clean_notebooks

Dataset card Data Studio Files Files and versions Community

Split (1)

train · 1.01M rows

code stringlengths 2.5k 150k	kind stringclasses 1 value
ansible azure.azcollection.azure_rm_privateendpoint_info – Get private endpoints info azure.azcollection.azure\_rm\_privateendpoint\_info – Get private endpoints info ================================================================================ Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_privateendpoint_info`. New in version 1.8.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts for private endpoints. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| Name of resource group. \| \| 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 \| \| Limit results by resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get facts for one private endpoint azure_rm_privateendpoint_info: resource_group: myResourceGroup name: testprivateendpoint - name: Get all private endpoint under the resource group azure_rm_privateendpoint_info: resource_group: myResourceGroup - name: Get all private endpoint under subscription azure_rm_virtualnetwork_info: tags: key1: value1 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| state complex \| always \| List of private endpoint dict with same format as M(azure\_rm\_privateendpoint) module paramter. \| \| \| etag string \| always \| A unique read-only string that changes whenever the resource is updated. Sample: W/"20803842-7d51-46b2-a790-ded8971b4d8a \| \| \| id string \| always \| Resource ID of the private endpoint. Sample: /subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/testprivateendpoint \| \| \| location string \| always \| Valid Azure location. Sample: eastus \| \| \| name string \| always \| Name of the private endpoint. Sample: estprivateendpoint \| \| \| network\_interfaces list / elements=string \| always \| List ID of the network interfaces. Sample: ['/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/fredprivateendpoint002.nic'] \| \| \| private\_link\_service\_connections list / elements=string \| always \| The resource id of the private endpoint to connect. Sample: ['/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/point/privateLinkServiceConnections/point'] \| \| \| provisioning\_state string \| always \| Provisioning state of the resource. Sample: Succeeded \| \| \| subnets\_id string \| always \| Subnets associated with the virtual network. Sample: /subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/fredtestRG-vnet/subnets/default \| \| \| tags dictionary \| always \| Tags assigned to the resource. Dictionary of string:string pairs. Sample: {'tag1': 'abc'} \| \| \| type string \| always \| Resource type. Sample: Microsoft.Network/privateEndpoints \| ### Authors * Fred-sun (@Fred-sun) ansible azure.azcollection.azure_rm_trafficmanagerprofile – Manage Azure Traffic Manager profile azure.azcollection.azure\_rm\_trafficmanagerprofile – Manage Azure Traffic Manager profile ========================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_trafficmanagerprofile`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete a Traffic Manager profile. 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-azure.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 \| 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. \| \| 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. \| \| dns\_config string \| \| The DNS settings of the Traffic Manager profile. \| \| \| relative\_name string \| \| The relative DNS name provided by this Traffic Manager profile. If not provided, name of the Traffic Manager will be used. \| \| \| ttl integer \| Default:60 \| The DNS Time-To-Live (TTL), in seconds. \| \| location string \| Default:"global" \| Valid Azure location. Defaults to `global` because in default public Azure cloud, Traffic Manager profile can only be deployed globally. Reference <https://docs.microsoft.com/en-us/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile>. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| monitor\_config string \| Default:{"path": "/", "port": 80, "protocol": "HTTP"} \| The endpoint monitoring settings of the Traffic Manager profile. \| \| \| interval integer \| \| The monitor interval for endpoints in this profile in seconds. \| \| \| path string \| \| The path relative to the endpoint domain name used to probe for endpoint health. \| \| \| port string \| \| The TCP port used to probe for endpoint health. \| \| \| protocol string \| Choices:* HTTP * HTTPS * TCP \| The protocol `HTTP`, `HTTPS` or `TCP` used to probe for endpoint health. \| \| \| timeout integer \| \| The monitor timeout for endpoints in this profile in seconds. \| \| \| tolerated\_failures string \| \| The number of consecutive failed health check before declaring an endpoint in this profile Degraded after the next failed health check. \| \| name string / required \| \| Name of the Traffic Manager profile. \| \| 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. \| \| profile\_status string \| Choices:* enabled ← * disabled \| The status of the Traffic Manager profile. \| \| resource\_group string / required \| \| Name of a resource group where the Traffic Manager profile exists or will be created. \| \| routing\_method string \| Choices:* performance ← * priority * weighted * geographic \| The traffic routing method of the Traffic Manager profile. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the Traffic Manager profile. Use `present` to create or update a Traffic Manager profile and `absent` to delete it. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a Traffic Manager Profile azure_rm_trafficmanagerprofile: name: tmtest resource_group: myResourceGroup location: global profile_status: enabled routing_method: priority dns_config: relative_name: tmtest ttl: 60 monitor_config: protocol: HTTPS port: 80 path: '/' tags: Environment: Test - name: Delete a Traffic Manager Profile azure_rm_trafficmanagerprofile: state: absent name: tmtest resource_group: myResourceGroup ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| endpoints list / elements=string \| when traffic manager endpoints exists \| List of endpoint IDs attached to the profile. Sample: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e2', '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e1'] \| \| id string \| when traffic manager profile exists \| The ID of the traffic manager profile. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest \| ### Authors * Hai Cao (@caohai) * Yunge Zhu (@yungezz)	programming_docs
ansible azure.azcollection.azure_rm_postgresqlfirewallrule – Manage PostgreSQL firewall rule instance azure.azcollection.azure\_rm\_postgresqlfirewallrule – Manage PostgreSQL firewall rule instance =============================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_postgresqlfirewallrule`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of PostgreSQL firewall rule. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| end\_ip\_address string \| \| The end IP address of the PostgreSQL firewall rule. Must be IPv4 format. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the PostgreSQL firewall rule. \| \| 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 \| \| The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| server\_name string / required \| \| The name of the server. \| \| start\_ip\_address string \| \| The start IP address of the PostgreSQL firewall rule. Must be IPv4 format. \| \| state string \| Choices:* absent * present ← \| Assert the state of the PostgreSQL firewall rule. Use `present` to create or update a PostgreSQL firewall rule and `absent` to delete it. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create (or update) PostgreSQL firewall rule azure_rm_postgresqlfirewallrule: resource_group: myResourceGroup server_name: testserver name: rule1 start_ip_address: 10.0.0.16 end_ip_address: 10.0.0.18 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver /firewallRules/rule1 \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_postgresqldatabase – Manage PostgreSQL Database instance azure.azcollection.azure\_rm\_postgresqldatabase – Manage PostgreSQL Database instance ====================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_postgresqldatabase`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of PostgreSQL Database. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| charset string \| \| The charset of the database. Check PostgreSQL documentation for possible values. This is only set on creation, use force\_update to recreate a database if the values don't match. \| \| 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. \| \| collation string \| \| The collation of the database. Check PostgreSQL documentation for possible values. This is only set on creation, use force\_update to recreate a database if the values don't match. \| \| force\_update boolean \| Choices:* no ← * yes \| When set to `true`, will delete and recreate the existing PostgreSQL database if any of the properties don't match what is set. When set to `false`, no change will occur to the database even if any of the properties do not match. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the database. \| \| 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 \| \| The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| server\_name string / required \| \| The name of the server. \| \| state string \| Choices:* absent * present ← \| Assert the state of the PostgreSQL database. Use `present` to create or update a database and `absent` to delete it. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create (or update) PostgreSQL Database azure_rm_postgresqldatabase: resource_group: myResourceGroup server_name: testserver name: db1 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroups/providers/Microsoft.DBforPostgreSQL/servers/testserve r/databases/db1 \| \| name string \| always \| Resource name. Sample: db1 \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_mariadbdatabase_info – Get Azure MariaDB Database facts azure.azcollection.azure\_rm\_mariadbdatabase\_info – Get Azure MariaDB Database facts ====================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_mariadbdatabase_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of MariaDB Database. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the database. \| \| 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 \| \| The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| server\_name string / required \| \| The name of the server. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get instance of MariaDB Database azure_rm_mariadbdatabase_info: resource_group: myResourceGroup server_name: server_name name: database_name - name: List instances of MariaDB Database azure_rm_mariadbdatabase_info: resource_group: myResourceGroup server_name: server_name ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| databases complex \| always \| A list of dictionaries containing facts for MariaDB Databases. \| \| \| charset string \| always \| The charset of the database. Sample: UTF8 \| \| \| collation string \| always \| The collation of the database. Sample: English\_United States.1252 \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/testser ver/databases/db1 \| \| \| name string \| always \| Resource name. Sample: db1 \| \| \| resource\_group string \| always \| Resource group name. Sample: testrg \| \| \| server\_name string \| always \| Server name. Sample: testserver \| ### Authors * Zim Kalinowski (@zikalino) * Matti Ranta (@techknowlogick)	programming_docs
ansible azure.azcollection.azure_rm_virtualmachinescalesetextension_info – Get Azure Virtual Machine Scale Set Extension facts azure.azcollection.azure\_rm\_virtualmachinescalesetextension\_info – Get Azure Virtual Machine Scale Set Extension facts ========================================================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_virtualmachinescalesetextension_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Azure Virtual Machine Scale Set Extension. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the virtual machine extension. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| vmss\_name string / required \| \| The name of VMSS containing the extension. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get information on specific Virtual Machine Scale Set Extension azure_rm_virtualmachineextension_info: resource_group: myResourceGroup vmss_name: myvmss name: myextension - name: List installed Virtual Machine Scale Set Extensions azure_rm_virtualmachineextension_info: resource_group: myrg vmss_name: myvmss ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| extensions complex \| always \| A list of dictionaries containing facts for Virtual Machine Extension. \| \| \| auto\_upgrade\_minor\_version boolean \| always \| Autoupgrade minor version flag. Sample: True \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/ myvmss/extensions/myextension \| \| \| name string \| always \| Virtual machine extension name. Sample: myextension \| \| \| provisioning\_state string \| always \| Provisioning state of the extension. Sample: Succeeded \| \| \| publisher string \| always \| Extension publisher. Sample: Microsoft.Azure.Extensions \| \| \| resource\_group string \| always \| Resource group name. Sample: myrg \| \| \| settings dictionary \| always \| Extension specific settings dictionary. Sample: {'commandToExecute': 'hostname'} \| \| \| type string \| always \| Extension type. Sample: CustomScript \| \| \| vmss\_name string \| always \| Virtual machine scale set name. Sample: myvmss \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_privatednsrecordset_info – Get Private DNS Record Set facts azure.azcollection.azure\_rm\_privatednsrecordset\_info – Get Private DNS Record Set facts ========================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_privatednsrecordset_info`. New in version 1.1.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts for a specific DNS Record Set in a Private DNS Zone, or a specific type of DNS record in all zones or one zone etc. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| 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. \| \| record\_type string \| \| Limit record sets by record type. \| \| relative\_name string \| \| Only show results for a Record Set. \| \| resource\_group string \| \| Limit results by resource group. Required when filtering by name or type. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| top integer \| \| Limit the maximum number of record sets to return. \| \| zone\_name string \| \| Limit results by zones. Required when filtering by name or type. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get facts for one record set in one Private DNS Zone azure_rm_privatednsrecordset_info: resource_group: myResourceGroup zone_name: newzone.com relative_name: servera record_type: A - name: Get facts for all Type A record sets in a Private DNS Zone azure_rm_privatednsrecordset_info: resource_group: myResourceGroup zone_name: newzone.com record_type: A - name: Get all record sets in a Private DNS Zone azure_rm_privatednsrecordset_info: resource_group: myResourceGroup zone_name: newzone.com ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| dnsrecordsets list / elements=dictionary \| always \| Gets a list of recordsets dict in a Private DNS zone. Sample: [{'fqdn': 'servera.newzone.com.', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/ Microsoft.Network/privateDnsZones/newzone.com/A/servera', 'record\_type': 'A', 'records': [{'ipv4\_address': '10.10.10.10'}], 'relative\_name': 'servera', 'time\_to\_live': 3600}, {'fqdn': 'serverb.newzone.com.', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/ Microsoft.Network/privateDnsZones/newzone.com/A/serverb', 'record\_type': 'A', 'records': [{'ipv4\_address': '10.10.10.11'}], 'relative\_name': 'serverb', 'time\_to\_live': 3600}] \| ### Authors * Aparna Patil (@aparna-patil) ansible azure.azcollection.azure_rm_gallery_info – Get Azure Shared Image Gallery info azure.azcollection.azure\_rm\_gallery\_info – Get Azure Shared Image Gallery info ================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_gallery_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get info of Azure Shared Image Gallery. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| Resource name \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: List galleries in a subscription. azure_rm_gallery_info: - name: List galleries in a resource group. azure_rm_gallery_info: resource_group: myResourceGroup - name: Get a gallery. azure_rm_gallery_info: resource_group: myResourceGroup name: myGallery ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| galleries complex \| always \| A list of dict results where the key is the name of the gallery and the values are the info for that gallery. \| \| \| description string \| always \| This is the gallery description. Sample: This is the gallery description. \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery \| \| \| location string \| always \| Resource location. Sample: eastus \| \| \| name string \| always \| Resource name. Sample: myGallery \| \| \| provisioning\_state string \| always \| The current state of the gallery. Sample: Succeeded \| \| \| tags dictionary \| always \| Resource tags. Sample: {'tag': 'value'} \| ### Authors * Liu Qingyi (@smile37773)	programming_docs
ansible azure.azcollection.azure_rm_batchaccount – Manages a Batch Account on Azure azure.azcollection.azure\_rm\_batchaccount – Manages a Batch Account on Azure ============================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_batchaccount`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of Azure Batch Account. 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-azure.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 \| 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. \| \| 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. \| \| auto\_storage\_account string \| \| Existing storage account with which to associate the Batch Account. It can be the storage account name which is in the same resource group. It can be the storage account ID. Fox example "/subscriptions/{subscription\_id}/resourceGroups/ {resource\_group}/providers/Microsoft.Storage/storageAccounts/{name}". It can be a dict which contains name and resource\_group of the storage account. \| \| 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. \| \| key\_vault string \| \| Existing key vault with which to associate the Batch Account. It can be the key vault name which is in the same resource group. It can be the key vault ID. For example "/subscriptions/{subscription\_id}/resourceGroups/ {resource\_group}/providers/Microsoft.KeyVault/vaults/{name}". It can be a dict which contains name and resource\_group of the key vault. \| \| location string \| \| Specifies the supported Azure location where the resource exists. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the Batch Account. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| pool\_allocation\_mode string \| Choices:* batch\_service ← * user\_subscription \| The pool acclocation mode of the Batch Account. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| resource\_group string / required \| \| The name of the resource group in which to create the Batch Account. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* present ← * absent \| Assert the state of the Batch Account. Use `present` to create or update a Batch Account and `absent` to delete it. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create Batch Account azure_rm_batchaccount: resource_group: MyResGroup name: mybatchaccount location: eastus auto_storage_account: name: mystorageaccountname pool_allocation_mode: batch_service ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| account\_endpoint string \| always \| The account endpoint used to interact with the Batch service. Sample: sampleacct.westus.batch.azure.com \| \| id string \| always \| The ID of the Batch account. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Batch/batchAccounts/sampleacct \| ### Authors * Junyi Yi (@JunyiYi) ansible azure.azcollection.azure_rm_privatednszone – Manage Azure private DNS zones azure.azcollection.azure\_rm\_privatednszone – Manage Azure private DNS zones ============================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_privatednszone`. New in version 0.0.1: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates and deletes Azure private DNS zones. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Name of the private DNS zone. \| \| 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. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the zone. Use `present` to create or update 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a private DNS zone azure_rm_privatednszone: resource_group: myResourceGroup name: example.com - name: Delete a private DNS zone azure_rm_privatednszone: resource_group: myResourceGroup name: example.com state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| state dictionary \| always \| Current state of the zone. Sample: {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup', 'location': 'global', 'name': 'Testing', 'number\_of\_record\_sets': 2, 'number\_of\_virtual\_network\_links': 0, 'number\_of\_virtual\_network\_links\_with\_registration': 0} \| ### Authors * Jose Angel Munoz (@imjoseangel) ansible azure.azcollection.azure_rm_route_info – Get Route info azure.azcollection.azure\_rm\_route\_info – Get Route info ========================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_route_info`. New in version 2.0.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get info of Route. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the route. \| \| 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 \| \| The name of the resource group. \| \| route\_table\_name string / required \| \| The name of the route table. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get route azure_rm_route_info: resource_group: myResourceGroup name: routename route_table_name: routetabename - name: List routes azure_rm_route_info: resource_group: myResourceGroup route_table_name: routetabename ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| routes complex \| always \| A list of dict results where the key is the name of the Route and the values are the facts for that Route. \| \| \| address\_prefix string \| always \| The destination CIDR to which the route applies. Sample: 10.0.0.0/25 \| \| \| etag string \| always \| A unique read-only string that changes whenever the resource is updated. Sample: fda240c5-6f42-4eb0-8f05-b1599dc722fe \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/routeTables/table01/routes/route01 \| \| \| name string \| always \| The name of the resource that is unique within a resource group. This name can be used to access the resource. Sample: route01 \| \| \| next\_hop\_ip\_address string \| always \| The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. Sample: 10.0.0.0 \| \| \| next\_hop\_type string \| always \| The type of Azure hop the packet should be sent to. Sample: VirtualAppliance \| \| \| provisioning\_state string \| always \| The provisioning state of the route resource. Sample: Succeeded \| ### Authors * GuopengLin (@t-glin) * Fred-Sun (@Fred-Sun) * Haiyuan Zhang (@haiyuazhang)	programming_docs
ansible azure.azcollection.azure_rm_sqldatabase_info – Get Azure SQL Database facts azure.azcollection.azure\_rm\_sqldatabase\_info – Get Azure SQL Database facts ============================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_sqldatabase_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Azure SQL Database. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| elastic\_pool\_name string \| \| The name of the elastic pool. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the database. \| \| 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 \| \| The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| server\_name string / required \| \| The name of the server. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags string \| \| Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get instance of SQL Database azure_rm_sqldatabase_info: resource_group: testrg server_name: testserver name: testdb - name: List instances of SQL Database azure_rm_sqldatabase_info: resource_group: testrg server_name: testserver elastic_pool_name: testep - name: List instances of SQL Database azure_rm_sqldatabase_info: resource_group: testrg server_name: testserver ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| databases complex \| always \| A list of dictionaries containing facts for SQL Database. \| \| \| collation string \| always \| The collation of the database. Sample: SQL\_Latin1\_General\_CP1\_CI\_AS \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Sql/servers/testserver/databases/testdb \| \| \| kind string \| always \| Kind of database. This is metadata used for the Azure portal experience. Sample: v12.0,user \| \| \| location string \| always \| Resource location. Sample: southeastasia \| \| \| name string \| always \| Database name. Sample: testdb \| \| \| sku complex \| always \| The name and tier of the SKU. \| \| \| \| capacity integer \| always \| The SKU capacity. Sample: 2 \| \| \| \| name string \| always \| The name of the SKU. Sample: BC\_Gen4\_2 \| \| \| \| tier string \| always \| The SKU tier. Sample: BusinessCritical \| \| \| status string \| always \| The status of the database. Sample: Online \| \| \| tags dictionary \| always \| Resource tags. Sample: {'taga': 'aaa', 'tagb': 'bbb'} \| \| \| zone\_redundant boolean \| always \| Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. Sample: True \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_iotdevicemodule – Manage Azure IoT hub device module azure.azcollection.azure\_rm\_iotdevicemodule – Manage Azure IoT hub device module ================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_iotdevicemodule`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, delete an Azure IoT hub device module. 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-azure.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 \| 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. \| \| 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\_method string \| Choices:* sas ← * certificate\_authority * self\_signed \| The authorization type an entity is to be created with. \| \| 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. \| \| desired dictionary \| \| Used along with reported properties to synchronize device configuration or conditions. The tag can be nested dictionary, '.', '$', '#', ' ' is not allowed in the key. List is not supported. \| \| device string / required \| \| Device name the module associate with. \| \| hub string / required \| \| Name of IoT Hub. \| \| hub\_policy\_key string / required \| \| Key of the hub\_policy\_name. \| \| hub\_policy\_name string / required \| \| Policy name of the IoT Hub which will be used to query from IoT hub. This policy should have at least 'Registry Read' access. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Name of the IoT hub device identity. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| primary\_key string \| \| Explicit self-signed certificate thumbprint to use for primary key. Explicit Shared Private Key to use for primary key. aliases: primary\_thumbprint \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| secondary\_key string \| \| Explicit self-signed certificate thumbprint to use for secondary key. Explicit Shared Private Key to use for secondary key. aliases: secondary\_thumbprint \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| State of the IoT hub. Use `present` to create or update an IoT hub device and `absent` to delete an IoT hub device. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| twin\_tags dictionary \| \| A section that the solution back end can read from and write to. Tags are not visible to device apps. The tag can be nested dictionary, '.', '$', '#', ' ' is not allowed in the key. List is not supported. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create simplest Azure IoT Hub device module azure_rm_iotdevicemodule: hub: myHub name: Testing device: mydevice hub_policy_name: iothubowner hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - name: Create Azure IoT Edge device module azure_rm_iotdevice: hub: myHub device: mydevice name: Testing hub_policy_name: iothubowner hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" edge_enabled: yes - name: Create Azure IoT Hub device module with module twin properties and tag azure_rm_iotdevice: hub: myHub name: Testing device: mydevice hub_policy_name: iothubowner hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" twin_tags: location: country: US city: Redmond sensor: humidity desired: period: 100 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| module dictionary \| always \| IoT Hub device. Sample: {'authentication': {'symmetricKey': {'primaryKey': 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'secondaryKey': 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'}, 'type': 'sas', 'x509Thumbprint': {'primaryThumbprint': None, 'secondaryThumbprint': None}}, 'cloudToDeviceMessageCount': 0, 'connectionState': 'Disconnected', 'connectionStateUpdatedTime': '0001-01-01T00:00:00', 'deviceId': 'mydevice', 'etag': 'ODM2NjI3ODg=', 'generationId': '636904759703045768', 'lastActivityTime': '0001-01-01T00:00:00', 'managedBy': None, 'moduleId': 'Testing'} \| ### Authors * Yuwei Zhou (@yuwzho) ansible azure.azcollection.azure_rm_availabilityset – Manage Azure Availability Set azure.azcollection.azure\_rm\_availabilityset – Manage Azure Availability Set ============================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_availabilityset`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete Azure Availability Set. * An availability set cannot be updated, you will have to recreate one instead. * The only update operation will be for the tags. 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-azure.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 \| 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. \| \| 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. \| \| location string \| \| Valid Azure location. Defaults to location of the resource group. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Name of the availability set. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| platform\_fault\_domain\_count integer \| Default:3 \| Fault domains define the group of virtual machines that share a common power source and network switch. Should be between `1` and `3`. \| \| platform\_update\_domain\_count integer \| Default:5 \| Update domains indicate groups of virtual machines and underlying physical hardware that can be rebooted at the same time. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| proximity\_placement\_group string \| \| The proximity placement group that the availability set should be assigned to. \| \| resource\_group string / required \| \| Name of a resource group where the availability set exists or will be created. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| sku string \| Choices:* Classic ← * Aligned \| Define if the availability set supports managed disks. \| \| state string \| Choices:* absent * present ← \| Assert the state of the availability set. Use `present` to create or update a availability set and `absent` to delete a availability set. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create an availability set with default options azure_rm_availabilityset: name: myAvailabilitySet location: eastus resource_group: myResourceGroup - name: Create an availability set with advanced options azure_rm_availabilityset: name: myAvailabilitySet location: eastus resource_group: myResourceGroup platform_update_domain_count: 5 platform_fault_domain_count: 3 proximity_placement_group: myProximityPlacementGroup sku: Aligned - name: Delete an availability set azure_rm_availabilityset: name: myAvailabilitySet location: eastus resource_group: myResourceGroup state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Whether or not the resource has changed Sample: True \| \| state complex \| always \| Current state of the availability set. \| \| \| id string \| success \| Resource ID. Sample: /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/availabilitySets/myavailabilityset2 \| \| \| location string \| success \| Location where the resource lives. Sample: eastus \| \| \| name string \| success \| Resource name. Sample: myavailabilityset2 \| \| \| platform\_fault\_domain\_count integer \| success \| Fault domains values. Sample: 2 \| \| \| platform\_update\_domain\_count integer \| success \| Update domains values. Sample: 5 \| \| \| proximity\_placement\_group string \| success \| The proximity placement group that the availability is assigned to. Sample: myProximityPlacementGroup \| \| \| sku string \| success \| The availability set supports managed disks. Sample: Aligned \| \| \| tags dictionary \| success \| Resource tags. Sample: {'env': 'sandbox'} \| ### Authors * Julien Stroheker (@julienstroheker)	programming_docs
ansible azure.azcollection.azure_rm_route – Manage Azure route resource azure.azcollection.azure\_rm\_route – Manage Azure route resource ================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_route`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update or delete a route. 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-azure.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 \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| ad\_user string \| \| Active Directory username. Use when authenticating with an Active Directory user rather than service principal. \| \| address\_prefix string \| \| The destination CIDR to which the route applies. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Name of the route. \| \| next\_hop\_ip\_address string \| \| The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. \| \| next\_hop\_type string \| Choices:* virtual\_network\_gateway * vnet\_local * internet * virtual\_appliance * none ← \| The type of Azure hop the packet should be sent to. \| \| 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. \| \| route\_table\_name string / required \| \| The name of the route table. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the route. Use `present` to create or update 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a route azure_rm_route: resource_group: myResourceGroup name: myRoute address_prefix: 10.1.0.0/16 next_hop_type: virtual_network_gateway route_table_name: table - name: Delete a route azure_rm_route: resource_group: myResourceGroup name: myRoute route_table_name: table state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| success \| Current state of the route. Sample: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/routeTables/tableb57/routes/routeb57 \| ### Authors * Yuwei Zhou (@yuwzho) ansible azure.azcollection.azure_rm_sqlfirewallrule_info – Get Azure SQL Firewall Rule facts azure.azcollection.azure\_rm\_sqlfirewallrule\_info – Get Azure SQL Firewall Rule facts ======================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_sqlfirewallrule_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of SQL Firewall Rule. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the firewall rule. \| \| 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 \| \| The name of the resource group that contains the server. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| server\_name string / required \| \| The name of the server. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get instance of SQL Firewall Rule azure_rm_sqlfirewallrule_info: resource_group: myResourceGroup server_name: testserver name: testrule - name: List instances of SQL Firewall Rule azure_rm_sqlfirewallrule_info: resource_group: myResourceGroup server_name: testserver ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| rules complex \| always \| A list of dict results containing the facts for matching SQL firewall rules. \| \| \| end\_ip\_address string \| always \| The end IP address of the firewall rule. Sample: 10.0.0.5 \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/testser ver/firewallRules/testrule \| \| \| name string \| always \| Firewall rule name. Sample: testrule \| \| \| resource\_group string \| always \| Resource group name. Sample: testgroup \| \| \| server\_name string \| always \| SQL server name. Sample: testserver \| \| \| start\_ip\_address string \| always \| The start IP address of the firewall rule. Sample: 10.0.0.1 \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_autoscale_info – Get Azure Auto Scale Setting facts azure.azcollection.azure\_rm\_autoscale\_info – Get Azure Auto Scale Setting facts ================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_autoscale_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Auto Scale Setting. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the Auto Scale Setting. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags string \| \| Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get instance of Auto Scale Setting azure_rm_autoscale_info: resource_group: myResourceGroup name: auto_scale_name - name: List instances of Auto Scale Setting azure_rm_autoscale_info: resource_group: myResourceGroup ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| autoscales list / elements=string \| always \| List of Azure Scale Settings dicts. Sample: [{'enabled': True, 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.insights/autoscalesettings/scale', 'location': 'eastus', 'name': 'scale', 'notifications': [{'custom\_emails': ['[email protected]'], 'send\_to\_subscription\_administrator': True, 'send\_to\_subscription\_co\_administrators': False, 'webhooks': []}], 'profiles': [{'count': '1', 'max\_count': '1', 'min\_count': '1', 'name': 'Auto created scale condition 0', 'recurrence\_days': ['Monday'], 'recurrence\_frequency': 'Week', 'recurrence\_hours': ['6'], 'recurrence\_mins': ['0'], 'recurrence\_timezone': 'China Standard Time', 'rules': [{'cooldown': 5.0, 'direction': 'Increase', 'metric\_name': 'Percentage CPU', 'metric\_resource\_uri': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsof t.Compute/virtualMachineScaleSets/myVmss', 'operator': 'GreaterThan', 'statistic': 'Average', 'threshold': 70.0, 'time\_aggregation': 'Average', 'time\_grain': 1.0, 'time\_window': 10.0, 'type': 'ChangeCount', 'value': '1'}]}], 'target': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScale Sets/myVmss'}] \| ### Authors * Yuwei Zhou (@yuwzho)	programming_docs
ansible azure.azcollection.azure_rm_loadbalancer_info – Get load balancer facts azure.azcollection.azure\_rm\_loadbalancer\_info – Get load balancer facts ========================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_loadbalancer_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts for a specific load balancer or all load balancers. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| Limit results to a specific resource group. \| \| 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 \| \| The resource group to search for the desired load balancer. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags string \| \| Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get facts for one load balancer azure_rm_loadbalancer_info: name: Testing resource_group: myResourceGroup - name: Get facts for all load balancers azure_rm_loadbalancer_info: - name: Get facts for all load balancers in a specific resource group azure_rm_loadbalancer_info: resource_group: myResourceGroup - name: Get facts by tags azure_rm_loadbalancer_info: tags: - testing ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| azure\_loadbalancers list / elements=string \| always \| List of load balancer dicts. \| ### Authors * Thomas Stringer (@trstringer) ansible azure.azcollection.azure_rm_lock_info – Manage Azure locks azure.azcollection.azure\_rm\_lock\_info – Manage Azure locks ============================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_lock_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, delete an Azure lock. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| managed\_resource\_id string \| \| ID of the resource where need to manage the lock. Get this via facts module. Cannot be set mutual with resource\_group. Manage subscription if both managed\_resource\_id and resource\_group not defined. '/subscriptions/{subscriptionId}' for subscriptions. '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}' for resource groups. '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{namespace}/{resourceType}/{resourceName}' for resources. Can get all locks with 'child scope' for this resource, use managed\_resource\_id in response for further management. \| \| name string / required \| \| Name of the lock. \| \| 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 \| \| Resource group name where need to manage the lock. The lock is in the resource group level. Cannot be set mutual with managed\_resource\_id. Query subscription if both managed\_resource\_id and resource\_group not defined. Can get all locks with 'child scope' in this resource group, use the managed\_resource\_id in response for further management. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get myLock details of myVM azure_rm_lock_info: name: myLock managed_resource_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM - name: List locks of myVM azure_rm_lock_info: managed_resource_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM - name: List locks of myResourceGroup azure_rm_lock_info: resource_group: myResourceGroup - name: List locks of myResourceGroup azure_rm_lock_info: managed_resource_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup - name: List locks of mySubscription azure_rm_lock_info: - name: List locks of mySubscription azure_rm_lock_info: managed_resource_id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| locks complex \| always \| List of locks dicts. \| \| \| id string \| always \| ID of the Lock. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/locks/myLock \| \| \| level string \| always \| Type level of the lock. Sample: can\_not\_delete \| \| \| name string \| always \| Name of the lock. Sample: myLock \| \| \| notes string \| always \| Notes of the lock added by creator. Sample: This is a lock \| ### Authors * Yuwei Zhou (@yuwzho) ansible azure.azcollection.azure_rm_mariadbfirewallrule – Manage MariaDB firewall rule instance azure.azcollection.azure\_rm\_mariadbfirewallrule – Manage MariaDB firewall rule instance ========================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_mariadbfirewallrule`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of MariaDB firewall rule. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| end\_ip\_address string \| \| The end IP address of the MariaDB firewall rule. Must be IPv4 format. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the MariaDB firewall rule. \| \| 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 \| \| The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| server\_name string / required \| \| The name of the server. \| \| start\_ip\_address string \| \| The start IP address of the MariaDB firewall rule. Must be IPv4 format. \| \| state string \| Choices:* absent * present ← \| Assert the state of the MariaDB firewall rule. Use `present` to create or update a rule and `absent` to ensure it is not present. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create (or update) MariaDB firewall rule azure_rm_mariadbfirewallrule: resource_group: myResourceGroup server_name: testserver name: rule1 start_ip_address: 10.0.0.17 end_ip_address: 10.0.0.20 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/testserver/fire wallRules/rule1 \| ### Authors * Zim Kalinowski (@zikalino) * Matti Ranta (@techknowlogick)	programming_docs
ansible azure.azcollection.azure_rm_rediscache_info – Get Azure Cache for Redis instance facts azure.azcollection.azure\_rm\_rediscache\_info – Get Azure Cache for Redis instance facts ========================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_rediscache_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts for Azure Cache for Redis instance. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| Limit results to a specific Azure Cache for Redis. \| \| 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 \| \| The resource group to search for the desired Azure Cache for Redis. \| \| return\_access\_keys boolean \| Choices:* no ← * yes \| Indicate weather to return access keys of the Azure Cache for Redis. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags string \| \| Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get Azure Cache for Redis by name azure_rm_rediscache_info: resource_group: myResourceGroup name: myRedis - name: Get Azure Cache for Redis with access keys by name azure_rm_rediscache_info: resource_group: myResourceGroup name: myRedis return_access_keys: true - name: Get Azure Cache for Redis in specific resource group azure_rm_rediscache_info: resource_group: myResourceGroup ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| rediscaches complex \| always \| List of Azure Cache for Redis instances. \| \| \| access\_keys dictionary \| when return\_access\_keys=true \| Azure Cache for Redis access keys. \| \| \| \| primary string \| always \| The current primary key that clients can use to authenticate the Redis cahce. Sample: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx= \| \| \| \| secondary string \| always \| The current secondary key that clients can use to authenticate the Redis cahce. Sample: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx= \| \| \| configuration dictionary \| always \| Dict of Redis configuration. Sample: maxmeory\_reserved \| \| \| enable\_non\_ssl\_port boolean \| always \| Specifies whether the non-ssl Redis server port (6379) is enabled. \| \| \| host\_name string \| always \| Redis host name. Sample: testRedis.redis.cache.windows.net \| \| \| id string \| always \| Id of the Azure Cache for Redis. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis \| \| \| location string \| always \| Location of the Azure Cache for Redis. Sample: WestUS \| \| \| name string \| always \| Name of the Azure Cache for Redis. Sample: myRedis \| \| \| provisioning\_state string \| always \| Provisioning state of the Redis cache. Sample: Creating \| \| \| resource\_group string \| always \| Name of a resource group where the Azure Cache for Redis belongs to. Sample: myResourceGroup \| \| \| shard\_count integer \| always \| The number of shards on a Premium Cluster Cache. Sample: 1 \| \| \| sku dictionary \| always \| Dict of SKU information. \| \| \| \| name string \| always \| Name of the SKU. Sample: standard \| \| \| \| size string \| always \| Size of the Azure Cache for Redis. Sample: C1 \| \| \| static\_ip string \| always \| Static IP address. Sample: 10.75.0.11 \| \| \| subnet string \| always \| The full resource ID of a subnet in a virtual network to deploy the Azure Cache for Redis in. Sample: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Network/VirtualNetworks/myVirtualNetwo rk/subnets/mySubnet'] \| \| \| tags dictionary \| always \| Resource tags. Sample: {'key1': 'value1'} \| \| \| tenant\_settings dictionary \| always \| Dict of tenant settings. Sample: {'key1': 'value1'} \| ### Authors * Yunge Zhu (@yungezz) ansible azure.azcollection.azure_rm_deployment_info – Get Azure Deployment facts azure.azcollection.azure\_rm\_deployment\_info – Get Azure Deployment facts =========================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_deployment_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Azure Deployment. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the deployment. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get instance of Deployment azure_rm_deployment_info: resource_group: myResourceGroup name: myDeployment ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| deployments complex \| always \| A list of dictionaries containing facts for deployments. \| \| \| id string \| always \| The identifier of the resource. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/myDeployment \| \| \| name string \| always \| Deployment name. Sample: myDeployment \| \| \| output\_resources complex \| always \| List of resources. \| \| \| \| depends\_on list / elements=string \| always \| List of resource ids. Sample: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGropup/providers/Microsoft.Network/virtualNet works/myVirtualNetwork'] \| \| \| \| id string \| always \| Resource id. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkI nterfaces/myNetworkInterface \| \| \| \| name string \| always \| Resource name. Sample: myNetworkInterface \| \| \| \| type string \| always \| Resource type. Sample: Microsoft.Network/networkInterfaces \| \| \| outputs string \| always \| Dictionary containing deployment outputs. \| \| \| parameters complex \| always \| Dictionary containing deployment parameters. \| \| \| provisioning\_state string \| always \| Provisioning state of the deployment. Sample: Succeeded \| \| \| resource\_group string \| always \| Resource group name. Sample: myResourceGroup \| \| \| template\_link string \| always \| Link to the template. Sample: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/d01a5c06f4f1bc03a049ca17bbbd6e06d62657b3/101-vm-simple-linux/ azuredeploy.json \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_mysqldatabase – Manage MySQL Database instance azure.azcollection.azure\_rm\_mysqldatabase – Manage MySQL Database instance ============================================================================ Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_mysqldatabase`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of MySQL Database. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| charset string \| \| The charset of the database. Check MySQL documentation for possible values. This is only set on creation, use force\_update to recreate a database if the values don't match. \| \| 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. \| \| collation string \| \| The collation of the database. Check MySQL documentation for possible values. This is only set on creation, use force\_update to recreate a database if the values don't match. \| \| force\_update boolean \| Choices:* no ← * yes \| When set to `true`, will delete and recreate the existing MySQL database if any of the properties don't match what is set. When set to `false`, no change will occur to the database even if any of the properties do not match. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the database. \| \| 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 \| \| The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| server\_name string / required \| \| The name of the server. \| \| state string \| Choices:* absent * present ← \| Assert the state of the MySQL Database. Use `present` to create or update a database and `absent` to delete it. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create (or update) MySQL Database azure_rm_mysqldatabase: resource_group: myResourceGroup server_name: testserver name: db1 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/testserver/databases/db1 \| \| name string \| always \| Resource name. Sample: db1 \| ### Authors * Zim Kalinowski (@zikalino)	programming_docs
ansible azure.azcollection.azure_rm_adapplication – Manage Azure Active Directory application azure.azcollection.azure\_rm\_adapplication – Manage Azure Active Directory application ======================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_adapplication`. New in version 1.6.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage Azure Active Directory application. 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-azure.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 \| 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. \| \| allow\_guests\_sign\_in boolean \| Choices:* no * yes \| A property on the application to indicate if the application accepts other IDPs or not or partially accepts. \| \| 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. \| \| app\_id string \| \| Application ID. \| \| app\_roles list / elements=dictionary \| \| Declare the roles you want to associate with your application. \| \| \| allowed\_member\_types list / elements=string / required \| \| Specifies whether this app role can be assigned to users and groups allowed\_member\_types=User. To other application's allowed\_member\_types=Application. Or both `User` and `Appplication`. \| \| \| description string \| \| The description for the app role. This is displayed when the app role is being assigned. if the app role functions as an application permission, during consent experiences. \| \| \| display\_name string \| \| Display name for the permission that appears in the app role assignment and consent experiences. \| \| \| is\_enabled boolean \| Choices:* no * yes \| When creating or updating an app role, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. \| \| \| value string \| \| Specifies the value to include in the roles claim in ID tokens and access tokens authenticating an assigned user or service principal. Must not exceed 120 characters in length. Allowed characters include ! Any other character, including the space character, are not allowed. \| \| 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. \| \| available\_to\_other\_tenants boolean \| Choices:* no * yes \| The application can be used from any Azure AD tenants. \| \| 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. \| \| credential\_description string \| \| The description of the password. \| \| display\_name string \| \| The display name of the application. \| \| end\_date string \| \| Date or datetime after which credentials expire(e.g. '2017-12-31'). Default value is one year after current time. \| \| homepage string \| \| The url where users can sign in and use your app. \| \| identifier\_uris list / elements=string \| \| Space-separated unique URIs that Azure AD can use for this app. \| \| key\_type string \| Choices:* AsymmetricX509Cert ← * Password * Symmetric \| The type of the key credentials associated with the application. \| \| key\_usage string \| Choices:* Sign * Verify ← \| The usage of the key credentials associated with the application. \| \| key\_value string \| \| The value for the key credentials associated with the application. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| native\_app boolean \| Choices:* no * yes \| An application which can be installed on a user's device or computer. \| \| oauth2\_allow\_implicit\_flow boolean \| Choices:* no * yes \| Whether to allow implicit grant flow for OAuth2. \| \| optional\_claims list / elements=dictionary \| \| Declare the optional claims for the application. \| \| \| additional\_properties string \| \| Additional properties of the claim. If a property exists in this collection, it modifies the behavior of the optional claim specified in the name property. \| \| \| essential boolean \| Choices:* no ← * yes \| If the value is true, the claim specified by the client is necessary to ensure a smooth authorization experience for the specific task requested by the end user. The default value is false. \| \| \| name string / required \| \| The name of the optional claim. \| \| \| source string \| \| The source (directory object) of the claim. There are predefined claims and user-defined claims from extension properties. If the source value is null, the claim is a predefined optional claim. If the source value is user, the value in the name property is the extension property from the user object. \| \| password string \| \| App password, aka 'client secret'. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| reply\_urls list / elements=string \| \| Space-separated URIs to which Azure AD will redirect in response to an OAuth 2.0 request. The value does not need to be a physical endpoint, but must be a valid URI. \| \| required\_resource\_accesses list / elements=dictionary \| \| Resource scopes and roles the application requires access to. Should be in manifest json format. \| \| \| resource\_access list / elements=dictionary \| \| The description of the app role. \| \| \| \| id string \| \| The unique identifier for one of the oauth2PermissionScopes or appRole instances that the resource application exposes. \| \| \| \| type string \| \| Specifies whether the id property references an oauth2PermissionScopes or an appRole. Possible values are Scope or Role. \| \| \| resource\_app\_id string \| \| The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| start\_date string \| \| Date or datetime at which credentials become valid, such as '2017-01-01'. Default value is current time. \| \| state string \| Choices:* absent * present ← \| Assert the state of Active Dirctory service principal. Use `present` to create or update a Password and use `absent` to delete. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string / required \| \| The tenant ID. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create ad application azure_rm_adapplication: tenant: "{{ tenant_id }}" display_name: "{{ display_name }}" - name: Create application with more parameter azure_rm_adapplication: tenant: "{{ tenant_id }}" display_name: "{{ display_name }}" available_to_other_tenants: False credential_description: "for test" end_date: 2021-10-01 start_date: 2021-05-18 identifier_uris: fredtest02.com - name: delete ad application azure_rm_adapplication: tenant: "{{ tenant_id }}" app_id: "{{ app_id }}" state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| output complex \| awalys \| Current state of the adapplication. \| \| \| app\_id string \| always \| The application ID. Sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \| \| \| available\_to\_other\_tenants boolean \| always \| The application can be used from any Azure AD tenants. \| \| \| display\_name string \| always \| Object's display name or its prefix. Sample: fredAKSCluster \| \| \| homepage string \| always \| The url where users can sign in and use your app. \| \| \| identifier\_uris list / elements=string \| always \| Space-separated unique URIs that Azure AD can use for this app. \| \| \| oauth2\_allow\_implicit\_flow boolean \| always \| Whether to allow implicit grant flow for OAuth2. \| \| \| object\_id string \| always \| Object ID of the application Sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \| \| \| optional\_claims list / elements=string \| always \| The optional claims for the application. \| \| \| reply\_urls list / elements=string \| always \| Space-separated URIs to which Azure AD will redirect in response to an OAuth 2.0 request. \| ### Authors * guopeng\_lin (@guopenglin) haiyuan\_zhang (@haiyuazhang) Fred-sun (@Fred-sun) ansible azure.azcollection.azure_rm_registrationassignment_info – Get RegistrationAssignment info azure.azcollection.azure\_rm\_registrationassignment\_info – Get RegistrationAssignment info ============================================================================================ Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_registrationassignment_info`. New in version 1.3.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get info of RegistrationAssignment. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| 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. \| \| registration\_assignment\_id string \| \| ID of the registration assignment. \| \| scope string / required \| \| Scope of the registration assignment. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get Registration Assignment azure_rm_registrationassignment_info: registration_assignment_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx scope: subscription/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup - name: Get All Registration Assignments in scope(subscription) azure_rm_registrationassignment_info: scope: subscription/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| registration\_assignments complex \| always \| A list of dict results where the key is the name of the RegistrationAssignment. The values are the facts for that RegistrationAssignment. \| \| \| id string \| always \| The fully qualified path of the registration assignment. Sample: /subscriptions/xxx-xxxf/providers/Microsoft.ManagedServices/registrationAssignments/xxx-xxx \| \| \| name string \| always \| Name of the registration assignment. Sample: 9b2895ec-fb1e-4a1e-a978-abd9933d6b20 \| \| \| properties complex \| always \| Properties of a registration assignment. \| \| \| \| registration\_definition\_id string \| always \| Fully qualified path of the registration definition. Sample: /subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxx-xxx \| \| \| type string \| always \| Type of the resource. Sample: Microsoft.ManagedServices/registrationAssignment \| ### Authors * Fred-Sun (@Fred-Sun)	programming_docs
ansible azure.azcollection.azure_rm_privatednszonelink_info – Get Virtual Network link facts for private DNS zone azure.azcollection.azure\_rm\_privatednszonelink\_info – Get Virtual Network link facts for private DNS zone ============================================================================================================ Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_privatednszonelink_info`. New in version 1.6.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get a specified virtual network link or all virtual network links facts for a Private DNS zone. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the virtual network link. \| \| 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. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags dictionary \| \| Limit the results by providing resource tags. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| zone\_name string / required \| \| The name of the Private DNS zone. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get facts for one virtual network link in private DNS zone azure_rm_privatednszonelink_info: resource_group: myResourceGroup name: vnetlink1 zone_name: privatezone.com - name: Get facts for all virtual network links in private DNS zone azure_rm_privatednszonelink_info: resource_group: myResourceGroup zone_name: privatezone.com ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| virtualnetworklinks list / elements=dictionary \| always \| Gets a list of virtual network links dict in a Private DNS zone. Sample: [{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/ Microsoft.Network/privateDnsZones/privatezone.com/virtualNetworkLinks/vnetlink1', 'name': 'vnetlink1', 'provisioning\_state': 'Succeeded', 'registration\_enabled': True, 'tags': {'key1': 'value1'}, 'virtual\_network': {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/ providers/Microsoft.Network/virtualNetworks/MyAzureVNet'}, 'virtual\_network\_link\_state': 'Completed'}] \| ### Authors * Aparna Patil (@techcon65) ansible azure.azcollection.azure_rm_trafficmanagerendpoint – Manage Azure Traffic Manager endpoint azure.azcollection.azure\_rm\_trafficmanagerendpoint – Manage Azure Traffic Manager endpoint ============================================================================================ Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_trafficmanagerendpoint`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete Azure Traffic Manager endpoint. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| enabled boolean \| Choices:* no * yes ← \| The status of the endpoint. \| \| geo\_mapping list / elements=string \| \| The list of countries/regions mapped to this endpoint when traffic manager profile has routing\_method of `geographic`. \| \| location string \| \| Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| min\_child\_endpoints integer \| \| The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type=nested\_endpoints. \| \| name string / required \| \| The name of the endpoint. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| priority integer \| \| The priority of this endpoint when traffic manager profile has routing\_method of priority. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints. No two endpoints can share the same priority value. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| profile\_name string / required \| \| Name of Traffic Manager profile where this endpoints attaches to. \| \| resource\_group string / required \| \| Name of a resource group where the Traffic Manager endpoint exists or will be created. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the Traffic Manager endpoint. Use `present` to create or update a Traffic Manager endpoint and `absent` to delete it. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| target string \| \| The fully-qualified DNS name of the endpoint. \| \| target\_resource\_id string \| \| The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type=external\_endpoints. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| type string / required \| Choices:* azure\_endpoints * external\_endpoints * nested\_endpoints \| The type of the endpoint. \| \| weight integer \| \| The weight of this endpoint when traffic manager profile has routing\_method of `weighted`. Possible values are from 1 to 1000. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: create a endpoint for a traffic manager profile azure_rm_trafficmanagerendpoint: resource_group: testresourcegroup profile_name: myprofilename name: testendpoint1 type: external_endpoints location: westus priority: 2 weight: 1 target: 1.2.3.4 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| when traffic manager endpoint exists \| The ID of the traffic manager endpoint. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/trafficManagerProfiles/testProfil e/externalEndpoints/testendpoint \| ### Authors * Hai Cao (@caohai) * Yunge Zhu (@yungezz) ansible azure.azcollection.azure_rm_proximityplacementgroup_info – Get proximity placement group facts azure.azcollection.azure\_rm\_proximityplacementgroup\_info – Get proximity placement group facts ================================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_proximityplacementgroup_info`. New in version 1.6.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts for specified proximity placement group or all proximity placement groups in a given resource group. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the proximity placement group. \| \| 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 \| \| Name of resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags dictionary \| \| Limit the results by providing resource tags. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get facts for one proximity placement group azure_rm_proximityplacementgroup_info: resource_group: myAzureResourceGroup name: myppg - name: Get facts for all proximity placement groups in resource group azure_rm_proximityplacementgroup_info: resource_group: myAzureResourceGroup ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| proximityplacementgroups list / elements=dictionary \| always \| Gets a list of proximity placement groups. Sample: [{'availability\_sets': [{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/ providers/Microsoft.Compute/availabilitySets/availabilityset1'}, {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/ providers/Microsoft.Compute/availabilitySets/availabilityset2'}], 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/providers/ Microsoft.Compute/proximityPlacementGroups/myppg', 'location': 'eastus', 'name': 'myppg', 'proximity\_placement\_group\_type': 'Standard', 'tags': {}, 'virtual\_machine\_scale\_sets': [], 'virtual\_machines': [{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/ providers/Microsoft.Compute/virtualMachines/mylinuxvm'}]}] \| ### Authors * Aparna Patil (@techcon65)	programming_docs
ansible azure.azcollection.azure_rm_privatednszonelink – Create, delete and update Virtual network link for Private DNS zone azure.azcollection.azure\_rm\_privatednszonelink – Create, delete and update Virtual network link for Private DNS zone ====================================================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_privatednszonelink`. New in version 1.6.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, deletes, and updates Virtual network links for an existing Azure Private DNS Zone. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the virtual network link. \| \| 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. \| \| registration\_enabled boolean \| Choices:* no ← * yes \| Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled \| \| resource\_group string / required \| \| Name of resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the virtual network link. Use `present` to create or update 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| virtual\_network string \| \| The reference of the virtual network. \| \| zone\_name string / required \| \| The name of the Private DNS zone. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a virtual network link azure_rm_privatednszonelink: resource_group: myResourceGroup name: vnetlink1 zone_name: privatezone.com virtual_network: MyAzureVNet state: present - name: Update virtual network link azure_rm_privatednszonelink: resource_group: myResourceGroup name: vnetlink1 zone_name: privatezone.com virtual_network: MyAzureVNet registration_enabled: true state: present tags: key1: "value1" - name: Delete a virtual network link azure_rm_privatednszonelink: resource_group: myResourceGroup name: vnetlink1 zone_name: privatezone.com state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| state complex \| always \| Current state of the Virtual network link. \| \| \| etag string \| always \| The etag of the virtual network link. Sample: 692c3e92-a618-46fc-aecd-8f888807cd6c \| \| \| id string \| always \| The Virtual network link ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/ Microsoft.Network/privateDnsZones/privatezone.com/virtualNetworkLinks/vnetlink1 \| \| \| location string \| always \| The Azure Region where the resource lives. Sample: global \| \| \| name string \| always \| Virtual network link name. Sample: vnetlink1 \| \| \| provisioning\_state string \| always \| The provisioning state of the resource. Sample: Succeeded \| \| \| registration\_enabled boolean \| always \| The status of auto-registration of virtual machine records in the virtual network in private DNS zone. Sample: True \| \| \| tags list / elements=string \| always \| Resource tags. Sample: [{'key1': 'value1'}] \| \| \| virtual\_network dictionary \| always \| Reference to virtual network. Sample: {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/ providers/Microsoft.Network/virtualNetworks/MyAzureVNet'} \| \| \| virtual\_network\_link\_state string \| always \| The status of the virtual network link. Sample: Completed \| ### Authors * Aparna Patil (@techcon65) ansible azure.azcollection.azure_rm_galleryimageversion_info – Get Azure SIG Image Version info azure.azcollection.azure\_rm\_galleryimageversion\_info – Get Azure SIG Image Version info ========================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_galleryimageversion_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get info of Azure SIG Image Version. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| gallery\_image\_name string / required \| \| The name of the gallery Image Definition in which the Image Version resides. \| \| gallery\_name string / required \| \| The name of the Shared Image Gallery in which the Image Definition resides. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| Resource name. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: List gallery image versions in a gallery image definition. azure_rm_galleryimageversion_info: resource_group: myResourceGroup gallery_name: myGallery gallery_image_name: myImage - name: Get a gallery image version. azure_rm_galleryimageversion_info: resource_group: myResourceGroup gallery_name: myGallery gallery_image_name: myImage name: myVersion ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| versions complex \| always \| A list of dict results where the key is the name of the version and the values are the info for that version. \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/images/myImage/versions/myVersion \| \| \| location string \| always \| Resource location. Sample: eastus \| \| \| name string \| always \| Resource name. Sample: myVersion \| \| \| provisioning\_state string \| success \| The current state of the gallery. Sample: Succeeded \| \| \| publishing\_profile dictionary \| success \| The publishing profile of a gallery image version. \| \| \| tags dictionary \| always \| Resource tags. Sample: {'tag': 'value'} \| ### Authors * Liu Qingyi (@smile37773) ansible azure.azcollection.azure_rm_subnet_info – Get Azure Subnet facts azure.azcollection.azure\_rm\_subnet\_info – Get Azure Subnet facts =================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_subnet_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Azure Subnet. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the subnet. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| virtual\_network\_name string / required \| \| The name of the virtual network. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get facts of specific subnet azure_rm_subnet_info: resource_group: myResourceGroup virtual_network_name: myVirtualNetwork name: mySubnet - name: List facts for all subnets in virtual network azure_rm_subnet_info: resource_group: myResourceGroup virtual_network_name: myVirtualNetwork name: mySubnet ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| subnets complex \| always \| A list of dictionaries containing facts for subnet. \| \| \| address\_prefix\_cidr string \| always \| CIDR defining the IPv4 address space of the subnet. Sample: 10.1.0.0/16 \| \| \| address\_prefixes\_cidr list / elements=string \| always \| CIDR defining the IPv4 and IPv6 address space of the subnet. Sample: ['10.2.0.0/24', 'fdda:e69b:1587:495e::/64'] \| \| \| delegations list / elements=string \| always \| Associated delegation of subnets \| \| \| \| actions list / elements=string \| when delegation is present \| list of actions associated with service of delegation Sample: ['Microsoft.Network/virtualNetworks/subnets/action'] \| \| \| \| name string \| when delegation is present \| name of delegation Sample: delegationname \| \| \| \| provisioning\_state string \| when delegation is present \| Provisioning state of delegation. Sample: Succeeded \| \| \| \| serviceName string \| when delegation is present \| service associated to delegation Sample: Microsoft.ContainerInstance/containerGroups \| \| \| id string \| always \| Subnet resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/my VirtualNetwork/subnets/mySubnet \| \| \| name string \| always \| Name of the subnet. Sample: mySubnet \| \| \| private\_endpoint\_network\_policies string \| always \| `Enabled` or `Disabled` apply network policies on private endpoints in the subnet. Sample: Enabled \| \| \| private\_link\_service\_network\_policies string \| always \| `Enabled` or `Disabled` apply network policies on private link service in the subnet. Sample: Disabled \| \| \| provisioning\_state string \| always \| Provisioning state. Sample: Succeeded \| \| \| resource\_group string \| always \| Name of resource group. Sample: myResourceGroup \| \| \| route\_table string \| always \| Associated route table ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/routeTables/myRouteTable \| \| \| security\_group string \| always \| Associated security group ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGr oups/myNsg \| \| \| service\_endpoints list / elements=string \| when available \| List of service endpoints. \| \| \| \| locations list / elements=string \| always \| A list of location names. Sample: ['eastus', 'westus'] \| \| \| \| provisioning\_state string \| always \| Provisioning state. Sample: Succeeded \| \| \| \| service string \| always \| The type of the endpoint service. Sample: Microsoft.Sql \| \| \| virtual\_network\_name string \| always \| Name of the containing virtual network. Sample: myVirtualNetwork \| ### Authors * Zim Kalinowski (@zikalino)	programming_docs
ansible azure.azcollection.azure_rm_trafficmanager – Manage a Traffic Manager profile. azure.azcollection.azure\_rm\_trafficmanager – Manage a Traffic Manager profile. ================================================================================ Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_trafficmanager`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete a Traffic Manager profile. 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-azure.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 \| 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. \| \| 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. \| \| dns\_config string \| \| The DNS settings of the Traffic Manager profile. \| \| \| relative\_name string \| \| The relative DNS name provided by this Traffic Manager profile. If no provided, name of the Traffic Manager will be used \| \| \| ttl string \| Default:60 \| The DNS Time-To-Live (TTL), in seconds. \| \| endpoints string \| \| The list of endpoints in the Traffic Manager profile. \| \| \| endpoint\_location string \| \| Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. \| \| \| endpoint\_status string \| Choices:* Enabled * Disabled \| The status of the endpoint. \| \| \| geo\_mapping string \| \| The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. \| \| \| id string \| \| Fully qualified resource Id for the resource. \| \| \| min\_child\_endpoints string \| \| The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'. \| \| \| name string / required \| \| The name of the endpoint. \| \| \| priority string \| \| The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints. No two endpoints can share the same priority value. \| \| \| target string \| \| The fully-qualified DNS name of the endpoint. \| \| \| target\_resource\_id string \| \| The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. \| \| \| type string / required \| \| The type of the endpoint. Ex- Microsoft.network/TrafficManagerProfiles/ExternalEndpoints. \| \| \| weight string \| \| The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. \| \| location string \| \| Valid azure location. Defaults to 'global'. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| monitor\_config string \| Default:{"path": "/", "port": 80, "protocol": "HTTP"} \| The endpoint monitoring settings of the Traffic Manager profile. \| \| \| interval\_in\_seconds string \| \| The monitor interval for endpoints in this profile. \| \| \| path string \| \| The path relative to the endpoint domain name used to probe for endpoint health. \| \| \| port string \| \| The TCP port used to probe for endpoint health. \| \| \| protocol string \| Choices:* HTTP * HTTPS * TCP \| The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. \| \| \| timeout\_in\_seconds string \| \| The monitor timeout for endpoints in this profile. \| \| \| tolerated\_number\_of\_failures string \| \| The number of consecutive failed health check before declaring an endpoint in this profile Degraded after the next failed health check. \| \| name string / required \| \| Name of the Traffic Manager profile. \| \| 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. \| \| profile\_status string \| Choices:* Enabled ← * Disabled \| The status of the Traffic Manager profile. \| \| resource\_group string / required \| \| Name of a resource group where the Traffic Manager profile exists or will be created. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the Traffic Manager profile. Use `present` to create or update a Traffic Manager profile and `absent` to delete it. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| traffic\_routing\_method string \| Choices:* Performance ← * Priority * Weighted * Geographic \| The traffic routing method of the Traffic Manager profile. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a Traffic Manager Profile azure_rm_trafficmanager: name: tmtest resource_group: tmt location: global profile_status: Enabled traffic_routing_method: Priority dns_config: relative_name: tmtest ttl: 60 monitor_config: protocol: HTTPS port: 80 path: '/' endpoints: - name: e1 type: Microsoft.network/TrafficManagerProfiles/ExternalEndpoints endpoint_location: West US 2 endpoint_status: Enabled priority: 2 target: 1.2.3.4 weight: 1 tags: Environment: Test - name: Delete a Traffic Manager Profile azure_rm_trafficmanager: state: absent name: tmtest resource_group: tmt ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| state dictionary \| always \| Current state of the Traffic Manager Profile Sample: {'dns\_config': {'fqdn': 'tmtest.trafficmanager.net', 'relative\_name': 'tmtest', 'ttl': 60}, 'endpoints': [{'endpoint\_location': 'West US 2', 'endpoint\_monitor\_status': 'Degraded', 'endpoint\_status': 'Enabled', 'geo\_mapping': None, 'id': '/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1', 'min\_child\_endpoints': None, 'name': 'e1', 'priority': 2, 'target': '1.2.3.4', 'target\_resource\_id': None, 'type': 'Microsoft.Network/trafficManagerProfiles/externalEndpoints', 'weight': 1}], 'id': '/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest', 'location': 'global', 'monitor\_config': {'interval\_in\_seconds': 30, 'path': '/', 'port': 80, 'profile\_monitor\_status': 'Degraded', 'protocol': 'HTTPS', 'timeout\_in\_seconds': 10, 'tolerated\_number\_of\_failures': 3}, 'name': 'tmtest', 'profile\_status': 'Enabled', 'tags': {'Environment': 'Test'}, 'traffic\_routing\_method': 'Priority', 'type': 'Microsoft.Network/trafficManagerProfiles'} \| ### Authors * Hai Cao <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1f6b32777e767c7e70393c2c2824393c2a2d24393c2b272472767c6d706c70796b393c2b29247c7072)> ansible azure.azcollection.azure_rm_servicebustopic – Manage Azure Service Bus azure.azcollection.azure\_rm\_servicebustopic – Manage Azure Service Bus ======================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_servicebustopic`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update or delete an Azure Service Bus topics. 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-azure.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 \| 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. \| \| 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. \| \| auto\_delete\_on\_idle\_in\_seconds integer \| \| Time idle interval after which a topic is automatically deleted. The minimum duration is 5 minutes. \| \| 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. \| \| default\_message\_time\_to\_live\_seconds integer \| \| Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself. \| \| duplicate\_detection\_time\_in\_seconds integer \| \| TimeSpan structure that defines the duration of the duplicate detection history. \| \| enable\_batched\_operations boolean \| Choices:* no * yes \| Value that indicates whether server-side batched operations are enabled. \| \| enable\_express boolean \| Choices:* no * yes \| Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage. \| \| enable\_partitioning boolean \| Choices:* no * yes \| A value that indicates whether the topic is to be partitioned across multiple message brokers. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| max\_size\_in\_mb integer \| \| The maximum size of the topic in megabytes, which is the size of memory allocated for the topic. \| \| name string / required \| \| Name of the topic. \| \| namespace string / required \| \| Servicebus namespace name. A namespace is a scoping container for all messaging components. Multipletopics can reside within a single namespace. \| \| 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. \| \| requires\_duplicate\_detection boolean \| Choices:* no * yes \| A value indicating if this topic requires duplicate detection. \| \| resource\_group string / required \| \| Name of resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the topic. Use `present` to create or update and use `absent` to delete. \| \| status string \| Choices:* active * disabled * send\_disabled * receive\_disabled \| Status of the entity. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| support\_ordering boolean \| Choices:* no * yes \| Value that indicates whether the topic supports ordering. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a topic azure_rm_servicebustopic: name: subtopic resource_group: myResourceGroup namespace: bar duplicate_detection_time_in_seconds: 600 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| success \| Current state of the topic. Sample: /subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/namespaces/nsb57dc95979/topics/topicb57dc95979 \| ### Authors * Yuwei Zhou (@yuwzho)	programming_docs
ansible azure.azcollection.azure_rm_containerinstance – Manage an Azure Container Instance azure.azcollection.azure\_rm\_containerinstance – Manage an Azure Container Instance ==================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_containerinstance`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete an Azure Container Instance. 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-azure.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 \| 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. \| \| 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. \| \| containers list / elements=dictionary \| \| List of containers. Required when creation. \| \| \| commands list / elements=string \| \| List of commands to execute within the container instance in exec form. When updating existing container all existing commands will be replaced by new ones. \| \| \| cpu float \| Default:1 \| The required number of CPU cores of the containers. \| \| \| environment\_variables list / elements=dictionary \| \| List of container environment variables. When updating existing container all existing variables will be replaced by new ones. \| \| \| \| is\_secure boolean \| Choices:* no * yes \| Is variable secure. \| \| \| \| name string / required \| \| Environment variable name. \| \| \| \| value string / required \| \| Environment variable value. \| \| \| image string / required \| \| The container image name. \| \| \| memory float \| Default:1.5 \| The required memory of the containers in GB. \| \| \| name string / required \| \| The name of the container instance. \| \| \| ports list / elements=integer \| \| List of ports exposed within the container group. \| \| \| volume\_mounts list / elements=dictionary \| \| The volume mounts for the container instance \| \| \| \| mount\_path string / required \| \| The path within the container where the volume should be mounted \| \| \| \| name string / required \| \| The name of the volume mount \| \| \| \| read\_only boolean \| Choices:* no * yes \| The flag indicating whether the volume mount is read-only \| \| dns\_name\_label string \| \| The Dns name label for the IP. \| \| force\_update boolean \| Choices:* no ← * yes \| Force update of existing container instance. Any update will result in deletion and recreation of existing containers. \| \| ip\_address string \| Choices:* public * none ← \| The IP address type of the container group. Default is `none` and creating an instance without public IP. \| \| location string \| \| Valid azure location. Defaults to location of the resource group. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the container group. \| \| os\_type string \| Choices:* linux ← * windows \| The OS type of containers. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| ports list / elements=integer \| \| List of ports exposed within the container group. This option is deprecated, using ports under containers". \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| registry\_login\_server string \| \| The container image registry login server. \| \| registry\_password string \| \| The password to log in container image registry server. \| \| registry\_username string \| \| The username to log in container image registry server. \| \| resource\_group string / required \| \| Name of resource group. \| \| restart\_policy string \| Choices:* always * on\_failure * never \| Restart policy for all containers within the container group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the container instance. Use `present` to create or update an container instance and `absent` to delete it. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| volumes list / elements=dictionary \| \| List of Volumes that can be mounted by containers in this container group. \| \| \| azure\_file dictionary \| \| The Azure File volume \| \| \| \| read\_only boolean \| Choices:* no * yes \| The flag indicating whether the Azure File shared mounted as a volume is read-only \| \| \| \| share\_name string / required \| \| The name of the Azure File share to be mounted as a volume \| \| \| \| storage\_account\_key string / required \| \| The storage account access key used to access the Azure File share \| \| \| \| storage\_account\_name string / required \| \| The name of the storage account that contains the Azure File share \| \| \| empty\_dir dictionary \| \| The empty directory volume \| \| \| git\_repo dictionary \| \| The git repo volume \| \| \| \| directory string \| \| Target directory name \| \| \| \| repository string / required \| \| Repository URL \| \| \| \| revision string \| \| Commit hash for the specified revision \| \| \| name string / required \| \| The name of the Volume \| \| \| secret dictionary \| \| The secret volume \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create sample container group azure_rm_containerinstance: resource_group: myResourceGroup name: myContainerInstanceGroup os_type: linux ip_address: public containers: - name: myContainer1 image: httpd memory: 1.5 ports: - 80 - 81 - name: Create sample container group with azure file share volume azure_rm_containerinstance: resource_group: myResourceGroup name: myContainerInstanceGroupz os_type: linux ip_address: public containers: - name: mycontainer1 image: httpd memory: 1 volume_mounts: - name: filesharevolume mount_path: "/data/files" ports: - 80 - 81 volumes: - name: filesharevolume azure_file: storage_account_name: mystorageaccount share_name: acishare storage_account_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - name: Create sample container group with git repo volume azure_rm_containerinstance: resource_group: myResourceGroup name: myContainerInstanceGroup os_type: linux ip_address: public containers: - name: mycontainer1 image: httpd memory: 1 volume_mounts: - name: myvolume1 mount_path: "/mnt/test" ports: - 80 - 81 volumes: - name: myvolume1 git_repo: repository: "https://github.com/Azure-Samples/aci-helloworld.git" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| containers list / elements=dictionary \| always \| The containers within the container group. Sample: [{'commands': None, 'cpu': 1.0, 'environment\_variables': None, 'image': 'httpd', 'memory': 1.0, 'name': 'mycontainer1', 'ports': [80, 81], 'volume\_mounts': [{'mount\_path': '/data/files', 'name': 'filesharevolume', 'read\_only': False}]}] \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89 \| \| ip\_address string \| if address is public \| Public IP Address of created container group. Sample: 175.12.233.11 \| \| provisioning\_state string \| always \| Provisioning state of the container. Sample: Creating \| \| volumes list / elements=dictionary \| if volumes specified \| The list of volumes that mounted by containers in container group \| \| \| azure\_file dictionary \| If Azure file share type of volume requested \| Azure file share volume details Sample: {'read\_only': None, 'share\_name': 'acishare', 'storage\_account\_key': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'storage\_account\_name': 'mystorageaccount'} \| \| \| empty\_dir dictionary \| If Empty directory type of volume requested \| Empty directory volume details \| \| \| git\_repo dictionary \| If Git repo type of volume requested \| Git Repo volume details Sample: {'directory': None, 'repository': 'https://github.com/Azure-Samples/aci-helloworld.git', 'revision': None} \| \| \| name string \| always \| The name of the Volume Sample: filesharevolume \| \| \| secret dictionary \| If Secret type of volume requested \| Secret volume details \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_mysqldatabase_info – Get Azure MySQL Database facts azure.azcollection.azure\_rm\_mysqldatabase\_info – Get Azure MySQL Database facts ================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_mysqldatabase_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of MySQL Database. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the database. \| \| 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 \| \| The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| server\_name string / required \| \| The name of the server. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get instance of MySQL Database azure_rm_mysqldatabase_info: resource_group: myResourceGroup server_name: server_name name: database_name - name: List instances of MySQL Database azure_rm_mysqldatabase_info: resource_group: myResourceGroup server_name: server_name ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| databases complex \| always \| A list of dictionaries containing facts for MySQL Databases. \| \| \| charset string \| always \| The charset of the database. Sample: utf8 \| \| \| collation string \| always \| The collation of the database. Sample: English\_United States.1252 \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/testser ver/databases/db1 \| \| \| name string \| always \| Resource name. Sample: db1 \| \| \| resource\_group string \| always \| Resource group name. Sample: testrg \| \| \| server\_name string \| always \| Server name. Sample: testserver \| ### Authors * Zim Kalinowski (@zikalino)	programming_docs
ansible azure.azcollection.azure_rm_backuppolicy – Manage Azure Backup Policy azure.azcollection.azure\_rm\_backuppolicy – Manage Azure Backup Policy ======================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_backuppolicy`. New in version 1.4.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create and delete instance of Azure Backup Policy. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| backup\_management\_type string \| Choices:* AzureIaasVM \| Defines the type of resource the policy will be applied to. \| \| 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. \| \| daily\_retention\_count integer \| \| The amount of days to retain backups. Does not apply to Weekly frequency. \| \| instant\_recovery\_snapshot\_retention integer \| \| How many days to retain instant recovery snapshots. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the backup policy. \| \| 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 \| \| The name of the resource group the vault is in. \| \| schedule\_days list / elements=string \| \| List of days to execute the schedule. Does not apply to Daily frequency. \| \| schedule\_run\_frequency string \| Choices:* Daily * Weekly \| The frequency to run the policy. \| \| schedule\_run\_time integer \| \| The hour to run backups. Valid choices are on 24 hour scale (0-23). \| \| schedule\_weekly\_frequency integer \| \| The amount of weeks between backups. Backup every schedule\_weekly\_frequency week(s) Azure will default behavior to running weekly if this is left blank Backup every schedule\_weekly\_frequency week(s). Azure will default behavior to running weekly if this is left blank. Does not apply to Daily frequency. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the backup policy. Use `present` to create or update a backup policy and `absent` to delete it. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| time\_zone string \| Default:"UTC" \| Timezone to apply schedule\_run\_time. \| \| vault\_name string / required \| \| The name of the Recovery Services Vault the policy belongs to. \| \| weekly\_retention\_count integer \| \| The amount of weeks to retain backups. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Delete a backup policy azure_rm_backuppolicy: vault_name: Vault_Name name: Policy_Name resource_group: Resource_Group_Name state: absent - name: Create a daily VM backup policy azure_rm_backuppolicy: vault_name: Vault_Name name: Policy_Name resource_group: Resource_Group_Name state: present backup_management_type: "AzureIaasVM" schedule_run_frequency: "Daily" instant_recovery_snapshot_retention: 2 daily_retention_count: 12 time_zone: "Pacific Standard Time" schedule_run_time: 14 - name: Create a weekly VM backup policy azure.azcollection.azure_rm_backuppolicy: vault_name: Vault_Name name: Policy_Name resource_group: Resource_Group_Name state: present backup_management_type: "AzureIaasVM" schedule_run_frequency: "Weekly" instant_recovery_snapshot_retention: 5 weekly_retention_count: 4 schedule_days: - "Monday" - "Wednesday" - "Friday" time_zone: "Pacific Standard Time" schedule_run_time: 8 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Id of specified backup policy. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/Vault\_Name/backupPolicies/Policy\_Name \| \| location string \| always \| Location of backup policy. Sample: eastus \| \| name string \| always \| Name of backup policy. Sample: DefaultPolicy \| \| type string \| always \| Type of backup policy. Sample: Microsoft.RecoveryServices/vaults/backupPolicies \| ### Authors * Cole Neubauer(@coleneubauer) ansible azure.azcollection.azure_rm_devtestlabartifactsource_info – Get Azure DevTest Lab Artifact Source facts azure.azcollection.azure\_rm\_devtestlabartifactsource\_info – Get Azure DevTest Lab Artifact Source facts ========================================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_devtestlabartifactsource_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Azure DevTest Lab Artifact Source. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| lab\_name string / required \| \| The name of DevTest Lab. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of DevTest Lab Artifact Source. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags list / elements=string \| \| Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get instance of DevTest Lab Artifact Source azure_rm_devtestlabartifactsource_info: resource_group: myResourceGroup lab_name: myLab name: myArtifactSource ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| artifactsources complex \| always \| A list of dictionaries containing facts for DevTest Lab Artifact Source. \| \| \| arm\_template\_folder\_path string \| always \| The folder containing Azure Resource Manager templates. Sample: /Environments \| \| \| display\_name string \| always \| The artifact source's display name. Sample: Public Artifact Repo \| \| \| folder\_path string \| always \| The folder containing artifacts. Sample: /Artifacts \| \| \| id string \| always \| The identifier of the artifact source. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/ar tifactSources/myArtifactSource \| \| \| is\_enabled string \| always \| Is the artifact source enabled. Sample: True \| \| \| lab\_name string \| always \| Name of the lab. Sample: myLab \| \| \| name string \| always \| The name of the artifact source. Sample: myArtifactSource \| \| \| provisioning\_state string \| always \| Provisioning state of artifact source. Sample: Succeeded \| \| \| resource\_group string \| always \| Name of the resource group. Sample: myResourceGroup \| \| \| source\_type string \| always \| The artifact source's type. Sample: github \| \| \| tags complex \| always \| The tags of the resource. Sample: { 'MyTag': 'MyValue' } \| \| \| uri string \| always \| URI of the artifact source. Sample: https://github.com/Azure/azure-devtestlab.git \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_cognitivesearch_info – Get Azure Cognitive Search service info azure.azcollection.azure\_rm\_cognitivesearch\_info – Get Azure Cognitive Search service info ============================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_cognitivesearch_info`. New in version 1.4.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get info for a specific Azure Cognitive Search service or all Azure Cognitive Search service within a resource group. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the Azure Cognitive Search service. \| \| 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 \| \| The name of the Azure resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| show\_keys boolean \| Choices:* no ← * yes \| Retrieve admin and query keys. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get Azure Cognitive Search info from resource group 'myResourceGroup' and name 'myAzureSearch' azure_rm_cognitivesearch_info: resource_group: myResourceGroup name: myAzureSearch - name: Get Azure Cognitive Search info from resource group 'myResourceGroup' azure_rm_cognitivesearch_info: resource_group: myResourceGroup - name: Get all Azure Cognitive Search info azure_rm_cognitivesearch_info: ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| search list / elements=string \| always \| Info for Azure Cognitive Search. \| \| \| hosting\_mode string \| always \| Type of hosting mode selected. Sample: default \| \| \| id string \| always \| The unique identifier associated with this Azure Cognitive Search. Sample: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} \| \| \| identity dictionary \| always \| The identity of the Azure Cognitive Search Service. Sample: {'principal\_id': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', 'type': 'SystemAssigned'} \| \| \| \| principal\_id string \| success \| Identifier assigned. Sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \| \| \| \| type string \| always \| Identity type. Sample: SystemAssigned \| \| \| keys dictionary \| success \| Admin and query keys for Azure Cognitive Search Service. \| \| \| \| admin\_primary string \| success \| Primary admin key for Azure Cognitive Search Service. Sample: 12345ABCDE67890FGHIJ123ABC456DEF \| \| \| \| admin\_secondary string \| success \| Secondary admin key for Azure Cognitive Search Service. Sample: 12345ABCDE67890FGHIJ123ABC456DEF \| \| \| \| query list / elements=string \| success \| List of query keys for Azure Cognitive Search Service. Sample: [{'key': '12345ABCDE67890FGHIJ123ABC456DEF', 'name': 'Query key'}] \| \| \| location string \| always \| The geo-location where the Azure Cognitive Search Service lives. Sample: West Europe \| \| \| name string \| always \| The name of the Azure Cognitive Search Service. Sample: myazuresearch \| \| \| network\_rule\_set list / elements=string \| always \| Network specific rules that determine how the Azure Cognitive Search service may be reached. Sample: ['1.1.1.1', '8.8.8.8/31'] \| \| \| partition\_count integer \| always \| The number of partitions in the Azure Cognitive Search Service. Sample: 3 \| \| \| provisioning\_state string \| always \| The state of the provisioning state of Azure Cognitive Search Service. Sample: succeeded \| \| \| public\_network\_access string \| always \| If it's allowed traffic over public interface. Sample: enabled \| \| \| replica\_count integer \| always \| The number of replicas in the Azure Cognitive Search Service. Sample: 3 \| \| \| sku string \| always \| The SKU of the Azure Cognitive Search Service. Sample: standard \| \| \| status string \| always \| The state of the Azure Cognitive Search. Sample: Active running \| \| \| tags dictionary \| always \| The resource tags. Sample: {'tag1': 'abc'} \| ### Authors * David Duque Hernández (@next-davidduquehernandez)	programming_docs
ansible azure.azcollection.azure_rm_backuppolicy_info – Get Info on Azure Backup Policy azure.azcollection.azure\_rm\_backuppolicy\_info – Get Info on Azure Backup Policy ================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_backuppolicy_info`. New in version 1.4.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create and delete instance of Azure Backup Policy. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the backup policy. \| \| 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 \| \| The name of the resource group the vault is in. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| vault\_name string / required \| \| The name of the Recovery Services Vault the policy belongs to. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get backup policy information azure_rm_backuppolicy_info: vault_name: Vault_Name name: Policy_Name resource_group: Resource_Group_Name register: backup_policy ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Id of specified backup policy. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.RecoveryServices/vaults/Vault\_Name/backupPolicies/Policy\_Name \| \| location string \| always \| Location of backup policy. Sample: eastus \| \| name string \| always \| Name of backup policy. Sample: DefaultPolicy \| \| type string \| always \| Type of backup policy. Sample: Microsoft.RecoveryServices/vaults/backupPolicies \| ### Authors * Cole Neubauer(@coleneubauer) ansible azure.azcollection.azure_rm_eventhub_info – Get Azure Event Hub azure.azcollection.azure\_rm\_eventhub\_info – Get Azure Event Hub ================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_eventhub_info`. New in version 1.6.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Azure Event Hub. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the Event hub. \| \| namespace\_name string \| \| The name of the namspace. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get facts of specific Event hub community.azure.azure_rm_eventhub_info: resource_group: myResourceGroup name: myEventHub ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| state dictionary \| always \| Current state of the Event Hub namesapce or Event Hub. Sample: {'additional\_properties': {}, 'created\_at': '2021-04-19T12:49:46.597Z', 'critical': None, 'data\_center': None, 'location': 'eastus', 'metric\_id': '149f0952-6f3d-48ba-9e98-57011575cbbd:eventhubtestns1753', 'name': 'eventhubtestns1753', 'namespace\_type': None, 'provisioning\_state': 'Succeeded', 'region': None, 'scale\_unit': None, 'service\_bus\_endpoint': 'https://eventhubtestns1753.servicebus.windows.net:443/', 'sku': 'Basic', 'status': 'Active', 'tags': {}, 'type': 'Microsoft.EventHub/Namespaces', 'updated\_at': '2021-04-19T12:54:33.397Z'} \| ### Authors * Saurabh Malpani (@saurabh3796) ansible azure.azcollection.azure_rm_applicationsecuritygroup – Manage Azure Application Security Group azure.azcollection.azure\_rm\_applicationsecuritygroup – Manage Azure Application Security Group ================================================================================================ Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_applicationsecuritygroup`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of Azure Application Security Group. 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-azure.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 \| 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. \| \| 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. \| \| location string \| \| Resource location. If not set, location from the resource group will be used as default. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the application security group. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the Application Security Group. Use `present` to create or update an Application Security Group and `absent` to delete it. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create application security group azure_rm_applicationsecuritygroup: resource_group: myResourceGroup name: mySecurityGroup location: eastus tags: foo: bar ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Resource id of the application security group. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationSecurityGroups/ mySecurityGroup \| ### Authors * Yunge Zhu (@yungezz)	programming_docs
ansible azure.azcollection.azure_rm_virtualmachinescalesetinstance_info – Get Azure Virtual Machine Scale Set Instance facts azure.azcollection.azure\_rm\_virtualmachinescalesetinstance\_info – Get Azure Virtual Machine Scale Set Instance facts ======================================================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_virtualmachinescalesetinstance_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Azure Virtual Machine Scale Set VMs. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| instance\_id string \| \| The instance ID of the virtual machine. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags string \| \| Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| vmss\_name string / required \| \| The name of the VM scale set. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: List VM instances in Virtual Machine ScaleSet azure_rm_virtualmachinescalesetinstance_info: resource_group: myResourceGroup vmss_name: myVMSS ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| instances complex \| always \| A list of dictionaries containing facts for Virtual Machine Scale Set VM. \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/my VMSS/virtualMachines/2 \| \| \| image\_reference dictionary \| always \| Image reference Sample: {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myGroup/providers/Microsoft.Compute/galleries/ myGallery/images/myImage/versions/10.1.3'} \| \| \| instance\_id string \| always \| Virtual Machine instance ID. \| \| \| latest\_model boolean \| always \| Whether applied latest model. Sample: True \| \| \| name string \| always \| Virtual Machine name. Sample: myVMSS\_2 \| \| \| power\_state string \| always \| Provisioning state of the Virtual Machine's power. Sample: running \| \| \| provisioning\_state string \| always \| Provisioning state of the Virtual Machine. Sample: Succeeded \| \| \| tags dictionary \| always \| Resource tags. Sample: {'tag1': 'abc'} \| \| \| vm\_id string \| always \| Virtual Machine ID Sample: 94a141a9-4530-46ac-b151-2c7ff09aa823 \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_recoveryservicesvault – Create and Delete Azure Recovery Services vault azure.azcollection.azure\_rm\_recoveryservicesvault – Create and Delete Azure Recovery Services vault ===================================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_recoveryservicesvault`. New in version 1.1.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create or Delete Azure Recovery Services vault. 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-azure.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 \| 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. \| \| 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. \| \| location string / required \| \| Azure Resource location. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the Azure Recovery Service Vault. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* present ← * absent \| Assert the state of the protection item. Use `present` for Creating Azure Recovery Service Vault. Use `absent` for Deleting Azure Recovery Service Vault. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create/Update Azure Recovery Service vault azure_rm_recoveryservicesvault: resource_group: 'myResourceGroup' name: 'testVault' location: 'westeurope' state: 'present' - name: Delete Recovery Service Vault azure_rm_recoveryservicesvault: resource_group: 'myResourceGroup' name: 'testVault' location: 'westeurope' state: 'absent' ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| response complex \| always \| The response about the current state of the recovery services vault. \| \| \| etag string \| always \| A unique read-only string that changes whenever the resource create. Sample: datetime'2020-09-16T02%3A44%3A27.834293Z' \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxx/resourceGroups/resourcegroup\_name/ providers/Microsoft.RecoveryServices/vaults/rev\_name \| \| \| location string \| always \| The location of the resource. Sample: eastus \| \| \| name string \| always \| Name of the recovery services vault name. Sample: revault\_name \| \| \| properties dictionary \| always \| The recovery service vault properties. Sample: {'privateEndpointStateForBackup': 'None', 'privateEndpointStateForSiteRecovery': 'None', 'provisioningState': 'Succeeded'} \| \| \| sku string \| always \| The sku type of the recovery service vault. Sample: Standard \| \| \| type string \| always \| The type of the recovery service vault. Sample: Microsoft.RecoveryServices/vaults \| ### Authors * Suyeb Ansari (@suyeb786) ansible azure.azcollection.azure_rm_virtualwan_info – Get VirtualWan info azure.azcollection.azure\_rm\_virtualwan\_info – Get VirtualWan info ==================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_virtualwan_info`. New in version 1.5.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get info of VirtualWan. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the VirtualWAN being retrieved. \| \| 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 \| \| The resource group name of the VirtualWan. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get Virtual WAN by name azure_rm_virtualwan_info: resource_group: myResouceGroup name: testwan - name: List all Virtual WANLs by resource group azure_rm_virtualwan_info: resource_group: myResourceGroup - name: List all Virtual WANs by subscription_id azure_rm_virtualwan_info: ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| virtual\_wans complex \| always \| A list of dict results where the key is the name of the VirtualWan and the values are the facts for that VirtualWan. \| \| \| allow\_branch\_to\_branch\_traffic boolean \| always \| True if branch to branch traffic is allowed. Sample: True \| \| \| allow\_vnet\_to\_vnet\_traffic boolean \| always \| True if Vnet to Vnet traffic is allowed. Sample: True \| \| \| disable\_vpn\_encryption boolean \| always \| Vpn encryption to be disabled or not. \| \| \| etag string \| always \| A unique read-only string that changes whenever the resource is updated. Sample: 86df6f3d-19f2-4cc8-8574-47921de4a6f1 \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/testwan \| \| \| location string \| always \| Resource location. Sample: eastus \| \| \| name string \| always \| Resource name. Sample: testwan \| \| \| office365\_local\_breakout\_category string \| always \| The office local breakout category. Sample: None \| \| \| provisioning\_state string \| always \| The provisioning state of the virtual WAN resource. Sample: Succeeded \| \| \| tags dictionary \| always \| Resource tags. Sample: {'key1': 'value1'} \| \| \| type string \| always \| Resource type. Sample: Microsoft.Network/virtualWans \| \| \| virtual\_hubs complex \| success \| List of VirtualHubs in the VirtualWAN. \| \| \| \| id string \| always \| The virtual hubs list of the virtual wan. Sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/test \| \| \| virtual\_wan\_type string \| always \| The type of virtual wan. Sample: Standard \| \| \| vpn\_sites complex \| always \| List of VpnSites in the VirtualWAN. \| \| \| \| id string \| always \| The vpn site resource ID. Sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/vpnSites/test1 \| ### Authors * Fred-Sun (@Fred-Sun)	programming_docs
ansible azure.azcollection.azure_rm_webapp – Manage Web App instances azure.azcollection.azure\_rm\_webapp – Manage Web App instances =============================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_webapp`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of Web App. 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-azure.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 \| 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. \| \| 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. \| \| app\_settings string \| \| Configure web app application settings. Suboptions are in key value pair format. \| \| app\_state string \| Choices:* started ← * stopped * restarted \| Start/Stop/Restart the web app. \| \| 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\_affinity\_enabled boolean \| Choices:* no * yes ← \| Whether or not to send session affinity cookies, which route client requests in the same session to the same instance. \| \| 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. \| \| container\_settings string \| \| Web app container settings. \| \| \| name string \| \| Name of the container, for example `imagename:tag`. To create a multi-container app, the name should be 'COMPOSE\|' or 'KUBE\|' followed by base64 encoded configuration. \| \| \| registry\_server\_password string \| \| The container registry server password. \| \| \| registry\_server\_url string \| \| Container registry server URL, for example `mydockerregistry.io`. \| \| \| registry\_server\_user string \| \| The container registry server user name. \| \| deployment\_source string \| \| Deployment source for git. \| \| \| branch string \| \| The branch name of the repository. \| \| \| url string \| \| Repository url of deployment source. \| \| dns\_registration boolean \| Choices:* no * yes \| Whether or not the web app hostname is registered with DNS on creation. Set to `false` to register. \| \| frameworks string \| \| Set of run time framework settings. Each setting is a dictionary. See <https://docs.microsoft.com/en-us/azure/app-service/app-service-web-overview> for more info. \| \| \| name string \| Choices:* java * net\_framework * php * python * ruby * dotnetcore * node \| Name of the framework. Supported framework list for Windows web app and Linux web app is different. Windows web apps support `java`, `net_framework`, `php`, `python`, and `node` from June 2018. Windows web apps support multiple framework at the same time. Linux web apps support `java`, `ruby`, `php`, `dotnetcore`, and `node` from June 2018. Linux web apps support only one framework. Java framework is mutually exclusive with others. \| \| \| settings string \| \| List of settings of the framework. \| \| \| \| java\_container string \| \| Name of Java container. Supported only when frameworks=java. Sample values `Tomcat`, `Jetty`. \| \| \| \| java\_container\_version string \| \| Version of Java container. Supported only when frameworks=java. Sample values for `Tomcat`, `8.0`, `8.5`, `9.0`. For `Jetty,`, `9.1`, `9.3`. \| \| \| version string \| \| Version of the framework. For Linux web app supported value, see <https://aka.ms/linux-stacks> for more info. `net_framework` supported value sample, `v4.0` for .NET 4.6 and `v3.0` for .NET 3.5. `php` supported value sample, `5.5`, `5.6`, `7.0`. `python` supported value sample, `5.5`, `5.6`, `7.0`. `node` supported value sample, `6.6`, `6.9`. `dotnetcore` supported value sample, `1.0`, `1.1`, `1.2`. `ruby` supported value sample, `2.3`. `java` supported value sample, `1.9` for Windows web app. `1.8` for Linux web app. \| \| https\_only boolean \| Choices:* no * yes \| Configures web site to accept only https requests. \| \| location string \| \| Resource location. If not set, location from the resource group will be used as default. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| plan string \| \| App service plan. Required for creation. Can be name of existing app service plan in same resource group as web app. Can be the resource ID of an existing app service plan. For example /subscriptions/<subs\_id>/resourceGroups/<resource\_group>/providers/Microsoft.Web/serverFarms/<plan\_name>. Can be a dict containing five parameters, defined below. `name`, name of app service plan. `resource_group`, resource group of the app service plan. `sku`, SKU of app service plan, allowed values listed on <https://azure.microsoft.com/en-us/pricing/details/app-service/linux/>. `is_linux`, whether or not the app service plan is Linux. defaults to `False`. `number_of_workers`, number of workers for app service plan. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| purge\_app\_settings boolean \| Choices:* no ← * yes \| Purge any existing application settings. Replace web app application settings with app\_settings. \| \| resource\_group string / required \| \| Name of the resource group to which the resource belongs. \| \| scm\_type string \| \| Repository type of deployment source, for example `LocalGit`, `GitHub`. List of supported values maintained at <https://docs.microsoft.com/en-us/rest/api/appservice/webapps/createorupdate#scmtype>. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| skip\_custom\_domain\_verification boolean \| Choices:* no * yes \| Whether or not to skip verification of custom (non \.azurewebsites.net) domains associated with web app. Set to `true` to skip. \| \| startup\_file* string \| \| The web's startup file. Used only for Linux web apps. \| \| state string \| Choices:* absent * present ← \| State of the Web App. Use `present` to create or update a Web App and `absent` to delete it. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| ttl\_in\_seconds string \| \| Time to live in seconds for web app default domain name. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a windows web app with non-exist app service plan azure_rm_webapp: resource_group: myResourceGroup name: myWinWebapp plan: resource_group: myAppServicePlan_rg name: myAppServicePlan is_linux: false sku: S1 - name: Create a docker web app with some app settings, with docker image azure_rm_webapp: resource_group: myResourceGroup name: myDockerWebapp plan: resource_group: myAppServicePlan_rg name: myAppServicePlan is_linux: true sku: S1 number_of_workers: 2 app_settings: testkey: testvalue testkey2: testvalue2 container_settings: name: ansible/ansible:ubuntu1404 - name: Create a docker web app with private acr registry azure_rm_webapp: resource_group: myResourceGroup name: myDockerWebapp plan: myAppServicePlan app_settings: testkey: testvalue container_settings: name: ansible/ubuntu1404 registry_server_url: myregistry.io registry_server_user: user registry_server_password: pass - name: Create a multi-container web app azure_rm_webapp: resource_group: myResourceGroup name: myMultiContainerWebapp plan: myAppServicePlan app_settings: testkey: testvalue container_settings: name: "COMPOSE\|{{ lookup('file', 'docker-compose.yml') \| b64encode }}" - name: Create a linux web app with Node 6.6 framework azure_rm_webapp: resource_group: myResourceGroup name: myLinuxWebapp plan: resource_group: myAppServicePlan_rg name: myAppServicePlan app_settings: testkey: testvalue frameworks: - name: "node" version: "6.6" - name: Create a windows web app with node, php azure_rm_webapp: resource_group: myResourceGroup name: myWinWebapp plan: resource_group: myAppServicePlan_rg name: myAppServicePlan app_settings: testkey: testvalue frameworks: - name: "node" version: 6.6 - name: "php" version: "7.0" - name: Create a stage deployment slot for an existing web app azure_rm_webapp: resource_group: myResourceGroup name: myWebapp/slots/stage plan: resource_group: myAppServicePlan_rg name: myAppServicePlan app_settings: testkey:testvalue - name: Create a linux web app with java framework azure_rm_webapp: resource_group: myResourceGroup name: myLinuxWebapp plan: resource_group: myAppServicePlan_rg name: myAppServicePlan app_settings: testkey: testvalue frameworks: - name: "java" version: "8" settings: java_container: "Tomcat" java_container_version: "8.5" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| azure\_webapp string \| always \| ID of current web app. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp \| ### Authors * Yunge Zhu (@yungezz) ansible azure.azcollection.azure_rm_resourcegroup – Manage Azure resource groups azure.azcollection.azure\_rm\_resourcegroup – Manage Azure resource groups ========================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_resourcegroup`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete a resource group. 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-azure.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 \| 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. \| \| 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. \| \| force\_delete\_nonempty boolean \| Choices:* no ← * yes \| Remove a resource group and all associated resources. Use with state=absent to delete a resource group that contains resources. aliases: force \| \| location string \| \| Azure location for the resource group. Required when creating a new resource group. Cannot be changed once resource group is created. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Name of the resource group. \| \| 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. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the resource group. Use `present` to create or update and `absent` to delete. When `absent` a resource group containing resources will not be removed unless the force option is used. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a resource group azure_rm_resourcegroup: name: myResourceGroup location: westus tags: testing: testing delete: never - name: Delete a resource group azure_rm_resourcegroup: name: myResourceGroup state: absent - name: Delete a resource group including resources it contains azure_rm_resourcegroup: name: myResourceGroup force_delete_nonempty: yes state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| contains\_resources boolean \| always \| Whether or not the resource group contains associated resources. Sample: True \| \| state complex \| always \| Current state of the resource group. \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup \| \| \| location string \| always \| Azure location for the resource group. Sample: westus \| \| \| name string \| always \| The resource group name. Sample: Testing \| \| \| provisioning\_state string \| always \| Provisioning state of the resource group. Sample: Succeeded \| \| \| tags dictionary \| always \| The resource group's tags. Sample: {'delete': 'on-exit', 'testing': 'no'} \| ### Authors * Chris Houseknecht (@chouseknecht) * Matt Davis (@nitzmahone)	programming_docs
ansible azure.azcollection.azure_rm_apimanagementservice_info – Get ApiManagementService info azure.azcollection.azure\_rm\_apimanagementservice\_info – Get ApiManagementService info ======================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_apimanagementservice_info`. New in version 1.5.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get info of ApiManagementService. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| Resource name. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get Api Management Service By Name and Resource Group azure_rm_apimanagementservice_info: resource_group: myResourceGroup name: myApiName - name: Get Api Management Service By Resource Group azure_rm_apimanagementservice_info: resource_group: myResourceGroup - name: Get Api Management Service By Subscription azure_rm_apimanagementservice_info: ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| api\_management\_service complex \| always \| A list of dict results where the key is the name of the ApiManagementService. The values are the facts for that ApiManagementService. \| \| \| etag string \| always \| ETag of the resource. Sample: AAAAAAAsQK8= \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.ApiManagement/service/myPolicy \| \| \| identity string \| always \| Identity of the resource. \| \| \| location string \| always \| Resource location. Sample: East US \| \| \| name string \| always \| Resource name. Sample: myPolicy \| \| \| properties dictionary \| always \| Properties of the API Management service. \| \| \| sku string \| always \| SKU properties of the API Management service. Sample: Developer \| \| \| tags dictionary \| always \| Resource tags. Sample: {'key1': 'value1'} \| \| \| type string \| always \| Resource type for API Management resource is set to Microsoft.ApiManagement. Sample: Microsoft.ApiManagement/service \| \| \| zones string \| always \| Zone of the resource. \| ### Authors * Nikhil Patne (@nikhilpatne) * Sakar Mehra (@Sakar97) ansible azure.azcollection.azure_rm_cosmosdbaccount – Manage Azure Database Account instance azure.azcollection.azure\_rm\_cosmosdbaccount – Manage Azure Database Account instance ====================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_cosmosdbaccount`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of Azure Database Account. 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-azure.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 \| 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. \| \| 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. \| \| consistency\_policy string \| \| The consistency policy for the Cosmos DB account. \| \| \| default\_consistency\_level string \| Choices:* eventual * session * bounded\_staleness * strong * consistent\_prefix \| The default consistency level and configuration settings of the Cosmos DB account. Required when state=present. \| \| \| max\_interval\_in\_seconds integer \| \| When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when default\_consistency\_policy=bounded\_staleness. \| \| \| max\_staleness\_prefix integer \| \| When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 - 2,147,483,647. Required when default\_consistency\_policy=bounded\_staleness. \| \| database\_account\_offer\_type string \| \| Database account offer type, for example Standard Required when state=present. \| \| enable\_automatic\_failover boolean \| Choices:* no * yes \| Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account. \| \| enable\_cassandra boolean \| Choices:* no * yes \| Enable Cassandra. \| \| enable\_gremlin boolean \| Choices:* no * yes \| Enable Gremlin. \| \| enable\_multiple\_write\_locations boolean \| Choices:* no * yes \| Enables the account to write in multiple locations \| \| enable\_table boolean \| Choices:* no * yes \| Enable Table. \| \| geo\_rep\_locations list / elements=string \| \| An array that contains the georeplication locations enabled for the Cosmos DB account. Required when state=present. \| \| \| failover\_priority integer \| \| The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. \| \| \| name string \| \| The name of the region. \| \| ip\_range\_filter string \| \| Cosmos DB Firewall support. This value specifies the set of IP addresses or IP address ranges. In CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces. \| \| is\_virtual\_network\_filter\_enabled boolean \| Choices:* no * yes \| Flag to indicate whether to enable/disable Virtual Network ACL rules. \| \| kind string \| Choices:* global\_document\_db * mongo\_db * parse \| Indicates the type of database account. This can only be set at database account creation. \| \| location string \| \| The location of the resource group to which the resource belongs. Required when state=present. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Cosmos DB database account name. \| \| 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 an Azure resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the Database Account. Use `present` to create or update an Database Account and `absent` to delete it. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| virtual\_network\_rules list / elements=string \| \| List of Virtual Network ACL rules configured for the Cosmos DB account. \| \| \| ignore\_missing\_vnet\_service\_endpoint boolean \| Choices:* no * yes \| Create Cosmos DB account without existing virtual network service endpoint. \| \| \| subnet string \| \| It can be a string containing resource id of a subnet. It can be a dictionary containing 'resource\_group', 'virtual\_network\_name' and 'subnet\_name' \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create Cosmos DB Account - min azure_rm_cosmosdbaccount: resource_group: myResourceGroup name: myDatabaseAccount location: westus geo_rep_locations: - name: southcentralus failover_priority: 0 database_account_offer_type: Standard - name: Create Cosmos DB Account - max azure_rm_cosmosdbaccount: resource_group: myResourceGroup name: myDatabaseAccount location: westus kind: mongo_db geo_rep_locations: - name: southcentralus failover_priority: 0 database_account_offer_type: Standard ip_range_filter: 10.10.10.10 enable_multiple_write_locations: yes virtual_network_rules: - subnet: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVi rtualNetwork/subnets/mySubnet" consistency_policy: default_consistency_level: bounded_staleness max_staleness_prefix: 10 max_interval_in_seconds: 1000 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| The unique resource identifier of the database account. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/myData baseAccount \| ### Authors * Zim Kalinowski (@zikalino)	programming_docs
ansible azure.azcollection.azure_rm_privatednsrecordset – Create, delete and update Private DNS record sets and records azure.azcollection.azure\_rm\_privatednsrecordset – Create, delete and update Private DNS record sets and records ================================================================================================================= Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_privatednsrecordset`. New in version 1.1.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, deletes, and updates Private DNS records sets and records within an existing Azure Private DNS Zone. 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-azure.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 \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| 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. \| \| record\_mode string \| Choices:* append * purge ← \| Whether existing record values not sent to the module should be purged. \| \| record\_type string / required \| Choices:* A * AAAA * CNAME * MX * PTR * SOA * SRV * TXT \| The type of record set to create or delete. \| \| records list / elements=dictionary \| \| List of records to be created depending on the type of record (set). \| \| \| entry string \| \| Primary data value for all record types. \| \| \| port integer \| \| Used for creating an `SRV` record set/records. \| \| \| preference integer \| \| Used for creating an `MX` record set/records. \| \| \| priority integer \| \| Used for creating an `SRV` record set/records. \| \| \| weight integer \| \| Used for creating an `SRV` record set/records. \| \| relative\_name string / required \| \| Relative name of the record set. \| \| resource\_group string / required \| \| Name of resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the record set. Use `present` to create or update 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| time\_to\_live integer \| Default:3600 \| Time to live of the record set in seconds. \| \| zone\_name string / required \| \| Name of the existing Private DNS zone in which to manage the record set. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: ensure an "A" record set with multiple records azure_rm_privatednsrecordset: resource_group: myResourceGroup relative_name: www zone_name: testing.com record_type: A records: - entry: 192.168.100.101 - entry: 192.168.100.102 - entry: 192.168.100.103 - name: delete a record set azure_rm_privatednsrecordset: resource_group: myResourceGroup record_type: A relative_name: www zone_name: testing.com state: absent - name: create multiple "A" record sets with multiple records azure_rm_privatednsrecordset: resource_group: myResourceGroup zone_name: testing.com relative_name: "{{ item.name }}" record_type: "{{ item.type }}" records: "{{ item.records }}" with_items: - { name: 'servera', type: 'A', records: [ { entry: '10.10.10.20' }, { entry: '10.10.10.21' }] } - { name: 'serverb', type: 'A', records: [ { entry: '10.10.10.30' }, { entry: '10.10.10.41' }] } - { name: 'serverc', type: 'A', records: [ { entry: '10.10.10.40' }, { entry: '10.10.10.41' }] } - name: create SRV records in a new record set azure_rm_privatednsrecordset: resource_group: myResourceGroup relative_name: _sip._tcp.testing.com zone_name: testing.com time_to_live: 7200 record_type: SRV records: - entry: sip.testing.com priority: 20 weight: 10 port: 5060 - name: create PTR record in a new record set azure_rm_privatednsrecordset: resource_group: myResourceGroup relative_name: 192.168.100.101.in-addr.arpa zone_name: testing.com record_type: PTR records: - entry: servera.testing.com - name: create TXT record in a new record set azure_rm_privatednsrecordset: resource_group: myResourceGroup relative_name: mail.testing.com zone_name: testing.com record_type: TXT records: - entry: 'v=spf1 a -all' ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| state complex \| always \| Current state of the DNS record set. \| \| \| a\_records list / elements=dictionary \| always \| A list of records in the record set. Sample: [{'ipv4\_address': '192.0.2.2'}, {'ipv4\_address': '192.0.2.4'}, {'ipv4\_address': '192.0.2.8'}] \| \| \| etag string \| always \| The etag of the record set. Sample: 692c3e92-a618-46fc-aecd-8f888807cd6c \| \| \| fqdn string \| always \| Fully qualified domain name of the record set. Sample: www.b57dc95985712e4523282.com \| \| \| id string \| always \| The DNS record set ID. Sample: /subscriptions/xxxx......xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/privateDnsZones/ b57dc95985712e4523282.com/A/www \| \| \| is\_auto\_registered boolean \| always \| Is the record set auto-registered in the Private DNS zone through a virtual network link. \| \| \| name string \| always \| Relate name of the record set. Sample: www \| \| \| ttl integer \| always \| The TTL(time-to-live) of the records in the records set. Sample: 3600 \| \| \| type string \| always \| The type of DNS record in this record set. Sample: A \| ### Authors * Aparna Patil (@aparna-patil) ansible azure.azcollection.azure_rm_mariadbserver_info – Get Azure MariaDB Server facts azure.azcollection.azure\_rm\_mariadbserver\_info – Get Azure MariaDB Server facts ================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_mariadbserver_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of MariaDB Server. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| The name of the server. \| \| 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 \| \| The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags list / elements=string \| \| Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get instance of MariaDB Server azure_rm_mariadbserver_info: resource_group: myResourceGroup name: server_name - name: List instances of MariaDB Server azure_rm_mariadbserver_info: resource_group: myResourceGroup ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| servers complex \| always \| A list of dictionaries containing facts for MariaDB servers. \| \| \| admin\_username string \| always \| The administrator's login name of a server. Sample: serveradmin \| \| \| enforce\_ssl boolean \| always \| Enable SSL enforcement. \| \| \| fully\_qualified\_domain\_name string \| always \| The fully qualified domain name of a server. Sample: myabdud1223.mys.database.azure.com \| \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/myabdud1223 \| \| \| location string \| always \| The location the resource resides in. Sample: eastus \| \| \| name string \| always \| Resource name. Sample: myabdud1223 \| \| \| resource\_group string \| always \| Resource group name. Sample: myResourceGroup \| \| \| sku complex \| always \| The SKU of the server. \| \| \| \| capacity integer \| always \| The scale capacity. Sample: 2 \| \| \| \| name string \| always \| The name of the SKU. Sample: GP\_Gen4\_2 \| \| \| \| tier string \| always \| The tier of the particular SKU. Sample: GeneralPurpose \| \| \| storage\_mb integer \| always \| The maximum storage allowed for a server. Sample: 128000 \| \| \| tags dictionary \| success \| Tags assigned to the resource. Dictionary of string:string pairs. Sample: {'tag1': 'abc'} \| \| \| user\_visible\_state string \| always \| A state of a server that is visible to user. Sample: Ready \| \| \| version string \| always \| Server version. Sample: 9.6 \| ### Authors * Zim Kalinowski (@zikalino) * Matti Ranta (@techknowlogick)	programming_docs
ansible azure.azcollection.azure_rm_roledefinition – Manage Azure Role Definition azure.azcollection.azure\_rm\_roledefinition – Manage Azure Role Definition =========================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_roledefinition`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of Azure Role Definition. 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-azure.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 \| 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. \| \| 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. \| \| assignable\_scopes list / elements=string \| \| List of assignable scopes of this definition. \| \| 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. \| \| description string \| \| The role definition description. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Unique name of role definition. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| permissions list / elements=dictionary \| \| Set of role definition permissions. See <https://docs.microsoft.com/en-us/azure/app-service/app-service-web-overview> for more info. \| \| \| actions list / elements=string \| \| List of allowed actions. \| \| \| data\_actions list / elements=string \| \| List of allowed data actions. \| \| \| not\_actions list / elements=string \| \| List of denied actions. \| \| \| not\_data\_actions list / elements=string \| \| List of denied data actions. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| scope string \| \| The scope of the role definition. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the role definition. Use `present` to create or update a role definition; use `absent` to delete it. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a role definition azure_rm_roledefinition: name: myTestRole scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourceGroup permissions: - actions: - "Microsoft.Compute/virtualMachines/read" data_actions: - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write" assignable_scopes: - "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| ID of current role definition. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId \| ### Authors * Yunge Zhu(@yungezz) ansible azure.azcollection.azure_rm_keyvaultkey_info – Get Azure Key Vault key facts azure.azcollection.azure\_rm\_keyvaultkey\_info – Get Azure Key Vault key facts =============================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_keyvaultkey_info`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get facts of Azure Key Vault key. 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-azure.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 \| 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. \| \| 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. \| \| 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. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string \| \| Key name. If not set, will list all keys in vault\_uri. \| \| 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. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| show\_deleted\_key boolean \| Choices:* no ← * yes \| Set to `true` to show deleted keys. Set to `false` to show not deleted keys. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags list / elements=string \| \| Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| vault\_uri string / required \| \| Vault uri where the key stored in. \| \| version string \| Default:"current" \| Key version. Set it to `current` to show latest version of a key. Set it to `all` to list all versions of a key. Set it to specific version to list specific version of a key. eg. fd2682392a504455b79c90dd04a1bf46. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get latest version of specific key azure_rm_keyvaultkey_info: vault_uri: "https://myVault.vault.azure.net" name: myKey - name: List all versions of specific key azure_rm_keyvaultkey_info: vault_uri: "https://myVault.vault.azure.net" name: myKey version: all - name: List specific version of specific key azure_rm_keyvaultkey_info: vault_uri: "https://myVault.vault.azure.net" name: myKey version: fd2682392a504455b79c90dd04a1bf46 - name: List all keys in specific key vault azure_rm_keyvaultkey_info: vault_uri: "https://myVault.vault.azure.net" - name: List deleted keys in specific key vault azure_rm_keyvaultkey_info: vault_uri: "https://myVault.vault.azure.net" show_deleted_key: True ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| keyvaults complex \| always \| List of keys in Azure Key Vault. \| \| \| attributes string \| success \| Key attributes. \| \| \| \| created string \| always \| Creation datetime. Sample: 2019-04-25T07:26:49+00:00 \| \| \| \| enabled string \| always \| Indicate whether the key is enabled. Sample: True \| \| \| \| expires string \| success \| Expiration datetime. Sample: 2019-04-25T07:26:49+00:00 \| \| \| \| not\_before string \| success \| Not before datetime. Sample: 2019-04-25T07:26:49+00:00 \| \| \| \| recovery\_level string \| always \| Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains `Purgeable` the key can be permanently deleted by a privileged user. Otherwise, only the system can purge the key, at the end of the retention interval. Sample: Purgable \| \| \| \| updated string \| always \| Update datetime. Sample: 2019-04-25T07:26:49+00:00 \| \| \| key string \| success \| public part of a key. \| \| \| \| crv string \| success \| Elliptic curve name. \| \| \| \| e string \| success \| RSA public exponent. \| \| \| \| n string \| success \| RSA modules. \| \| \| \| x string \| success \| X component of an EC public key. \| \| \| \| y string \| success \| Y component of an EC public key. \| \| \| kid string \| always \| Key identifier. Sample: https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46 \| \| \| managed boolean \| success \| `True` if the key's lifetime is managed by key vault. Sample: True \| \| \| permitted\_operations list / elements=string \| always \| Permitted operations on the key. Sample: encrypt \| \| \| tags list / elements=string \| always \| Tags of the key. Sample: ['foo'] \| \| \| type string \| always \| Key type. Sample: RSA \| \| \| version string \| always \| Key version. Sample: fd2682392a504455b79c90dd04a1bf46 \| ### Authors * Yunge Zhu (@yungezz) ansible azure.azcollection.azure_rm_iothub – Manage Azure IoT hub azure.azcollection.azure\_rm\_iothub – Manage Azure IoT hub =========================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_iothub`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, delete an Azure IoT hub. 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-azure.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 \| 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. \| \| 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. \| \| enable\_file\_upload\_notifications boolean \| Choices:* no * yes \| File upload notifications are enabled if set to `True`. \| \| event\_endpoint dictionary \| \| The Event Hub-compatible endpoint property. \| \| \| partition\_count integer \| \| The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See <https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages>. Default is `2`. \| \| \| retention\_time\_in\_days integer \| \| The retention time for device-to-cloud messages in days. See <https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages>. Default is `1`. \| \| ip\_filters list / elements=string \| \| Configure rules for rejecting or accepting traffic from specific IPv4 addresses. \| \| \| action string / required \| Choices:* accept * reject \| The desired action for requests captured by this rule. \| \| \| ip\_mask string / required \| \| A string that contains the IP address range in CIDR notation for the rule. \| \| \| name string / required \| \| Name of the filter. \| \| location string \| \| Location of the IoT hub. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| Name of the IoT hub. \| \| 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. \| \| routes list / elements=string \| \| Route device-to-cloud messages to service-facing endpoints. \| \| \| condition string \| \| The query expression for the routing query that is run against the message application properties, system properties, message body, device twin tags, and device twin properties to determine if it is a match for the endpoint. For more information about constructing a query, see <https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax> \| \| \| enabled boolean / required \| Choices:* no * yes \| Whether to enable the route. \| \| \| endpoint\_name string / required \| \| The name of the endpoint in routing\_endpoints where IoT Hub sends messages that match the query. \| \| \| name string / required \| \| Name of the route. \| \| \| source string / required \| Choices:* device\_messages * twin\_change\_events * device\_lifecycle\_events * device\_job\_lifecycle\_events \| The origin of the data stream to be acted upon. \| \| routing\_endpoints list / elements=string \| \| Custom endpoints. \| \| \| connection\_string string / required \| \| Connection string of the custom endpoint. The connection string should have send privilege. \| \| \| container string \| \| Container name of the custom endpoint when resource\_type=storage. \| \| \| encoding string \| \| Encoding of the message when resource\_type=storage. \| \| \| name string / required \| \| Name of the custom endpoint. \| \| \| resource\_group string \| \| Resource group of the endpoint. Default is the same as resource\_group. \| \| \| resource\_type string / required \| Choices:* eventhub * queue * storage * topic \| Resource type of the custom endpoint. \| \| \| subscription string \| \| Subscription id of the endpoint. Default is the same as subscription. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| sku string \| Choices:* b1 * b2 * b3 * f1 * s1 * s2 * s3 \| Pricing tier for Azure IoT Hub. Note that only one free IoT hub instance is allowed in each subscription. Exception will be thrown if free instances exceed one. Default is `s1` when creation. \| \| state string \| Choices:* absent * present ← \| State of the IoT hub. Use `present` to create or update an IoT hub and `absent` to delete an IoT hub. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| unit integer \| \| Units in your IoT Hub. Default is `1`. \| 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create a simplest IoT hub azure_rm_iothub: name: Testing resource_group: myResourceGroup - name: Create an IoT hub with route azure_rm_iothub: resource_group: myResourceGroup name: Testing routing_endpoints: - connection_string: "Endpoint=sb://qux.servicebus.windows.net/;SharedAccessKeyName=quux;SharedAccessKey=**;EntityPath=myQueue" name: foo resource_type: queue resource_group: myResourceGroup1 routes: - name: bar source: device_messages endpoint_name: foo enabled: yes ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cloud\_to\_device complex \| success \| Cloud to device message properties. \| \| \| max\_delivery\_count integer \| success \| The number of times the IoT hub attempts to deliver a message on the feedback queue. See <https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages>. Sample: 10 \| \| \| ttl\_as\_iso8601 string \| success \| The period of time for which a message is available to consume before it is expired by the IoT hub. See <https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages>. Sample: 1:00:00 \| \| enable\_file\_upload\_notifications boolean \| success \| Whether file upload notifications are enabled. Sample: True \| \| event\_endpoints complex \| success \| Built-in endpoint where to deliver device message. \| \| \| endpoint string \| success \| The Event Hub-compatible endpoint. Sample: sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/ \| \| \| partition\_count integer \| success \| The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See <https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages>. Sample: 2 \| \| \| partition\_ids list / elements=string \| success \| List of the partition id for the event endpoint. Sample: ['0', '1'] \| \| \| retention\_time\_in\_days integer \| success \| The retention time for device-to-cloud messages in days. See <https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages>. Sample: 1 \| \| host\_name string \| success \| Host of the IoT hub. Sample: testing.azure-devices.net \| \| id string \| success \| Resource ID of the IoT hub. Sample: /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing \| \| ip\_filters complex \| success \| Configure rules for rejecting or accepting traffic from specific IPv4 addresses. \| \| \| action string \| success \| The desired action for requests captured by this rule. Sample: Reject \| \| \| ip\_mask string \| success \| A string that contains the IP address range in CIDR notation for the rule. Sample: 40.54.7.3 \| \| \| name string \| success \| Name of the filter. Sample: filter \| \| location string \| success \| Location of the IoT hub. Sample: eastus \| \| name string \| success \| Name of the IoT hub. Sample: Testing \| \| resource\_group string \| success \| Resource group of the IoT hub. Sample: myResourceGroup. \| \| routes complex \| success \| Route device-to-cloud messages to service-facing endpoints. \| \| \| condition** boolean \| success \| The query expression for the routing query that is run against the message application properties, system properties, message body, device twin tags, and device twin properties to determine if it is a match for the endpoint. For more information about constructing a query, see https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax Sample: true \| \| \| enabled string \| success \| Whether to enable the route. Sample: True \| \| \| endpoint\_name string \| success \| The name of the endpoint in `routing_endpoints` where IoT Hub sends messages that match the query. Sample: foo \| \| \| name string \| success \| Name of the route. Sample: route1 \| \| \| source string \| success \| The origin of the data stream to be acted upon. Sample: device\_messages \| \| routing\_endpoints complex \| success \| Custom endpoints. \| \| \| event\_hubs complex \| success \| List of custom endpoints of event hubs. \| \| \| \| connection\_string string \| success \| Connection string of the custom endpoint. Sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=\\\\;EntityPath=foo \| \| \| \| name string \| success \| Name of the custom endpoint. Sample: foo \| \| \| \| resource\_group string \| success \| Resource group of the endpoint. Sample: bar \| \| \| \| subscription string \| success \| Subscription id of the endpoint. Sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX \| \| \| service\_bus\_queues complex \| always \| List of custom endpoints of service bus queue. \| \| \| \| connection\_string string \| success \| Connection string of the custom endpoint. Sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=\\\\;EntityPath=foo \| \| \| \| name string \| success \| Name of the custom endpoint. Sample: foo \| \| \| \| resource\_group string \| success \| Resource group of the endpoint. Sample: bar \| \| \| \| subscription string \| success \| Subscription ID of the endpoint. Sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX \| \| \| service\_bus\_topics complex \| success \| List of custom endpoints of service bus topic. \| \| \| \| connection\_string string \| success \| Connection string of the custom endpoint. Sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=\\\\;EntityPath=foo \| \| \| \| name string \| success \| Name of the custom endpoint. Sample: foo \| \| \| \| resource\_group string \| success \| Resource group of the endpoint. Sample: bar \| \| \| \| subscription string \| success \| Subscription ID of the endpoint. Sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX \| \| \| storage\_containers complex \| success \| List of custom endpoints of storage \| \| \| \| connection\_string string \| success \| Connection string of the custom endpoint. Sample: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=\\\\;EntityPath=foo \| \| \| \| name string \| success \| Name of the custom endpoint. Sample: foo \| \| \| \| resource\_group string \| success \| Resource group of the endpoint. Sample: bar \| \| \| \| subscription string \| success \| Subscription ID of the endpoint. Sample: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX \| \| sku string \| success \| Pricing tier for Azure IoT Hub. Sample: f1 \| \| unit integer \| success \| Units in the IoT Hub. Sample: 1 \| ### Authors * Yuwei Zhou (@yuwzho)	programming_docs
ansible azure.azcollection.azure_rm_gallery – Manage Azure Shared Image Gallery instance azure.azcollection.azure\_rm\_gallery – Manage Azure Shared Image Gallery instance ================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_gallery`. New in version 0.1.2: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update and delete instance of Azure Shared Image Gallery (SIG). 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-azure.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 \| 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. \| \| 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. \| \| description string \| \| The description of this Shared Image Gallery resource. This property is updatable. \| \| location string \| \| Resource location. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the Shared Image Gallery. Valid names consist of less than 80 alphanumeric characters, underscores and periods. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| Assert the state of the Gallery. Use `present` to create or update an Gallery and `absent` to delete it. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create or update a simple gallery. azure_rm_gallery: resource_group: myResourceGroup name: myGallery1283 location: West US description: This is the gallery description. ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery1283 \| ### Authors * Zim Kalinowski (@zikalino) ansible azure.azcollection.azure_rm_apimanagement_info – Get the infomation of the API Instance azure.azcollection.azure\_rm\_apimanagement\_info – Get the infomation of the API Instance ========================================================================================== Note This plugin is part of the [azure.azcollection collection](https://galaxy.ansible.com/azure/azcollection) (version 1.10.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`. To use it in a playbook, specify: `azure.azcollection.azure_rm_apimanagement_info`. New in version 1.6.0: of azure.azcollection * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get the information of api instance. 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-azure.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 \| 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. \| \| api\_id string \| \| API revision identifier. It must be unique in the current API Management service instance. \| \| 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. \| \| expand\_api\_version\_set boolean \| Choices:* no * yes \| Include full ApiVersionSet resource in response \| \| include\_not\_tagged\_apis boolean \| Choices:* no * yes \| Included not tagged APIs in the response. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| 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 \| \| The name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| service\_name string / required \| \| The name of the API Management service. \| \| 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. 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. \| \| tenant string \| \| Azure tenant ID. 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](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Get the information of api azure_rm_apimanagement_info: resource_group: myResourceGroup service_name: myService - name: Get the information of api azure_rm_apimanagement_info: resource_group: myResourceGroup service_name: myService api_id: testApi ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| api complex \| always \| A list of dict results where the key is the name of the Api and the values are the facts for that Api. \| \| \| api\_name complex \| success \| The api name provided by the user. \| \| \| \| id string \| always \| Resource ID. \| \| \| \| name string \| always \| Resource name. \| \| \| \| properties dictionary \| always \| Api entity contract properties. \| \| \| \| type string \| always \| Resource type for API Management resource. \| ### Authors * Sakar Mehra (@sakar97) * Nikhil Patne (@nikhilpatne) ansible Collections in the F5networks Namespace Collections in the F5networks Namespace ======================================= These are the collections with docs hosted on [docs.ansible.com](https://docs.ansible.com/) in the f5networks namespace. * [f5networks.f5\_modules](f5_modules/index#plugins-in-f5networks-f5-modules) ansible f5networks.f5_modules.bigip_gtm_monitor_firepass – Manages F5 BIG-IP GTM FirePass monitors f5networks.f5\_modules.bigip\_gtm\_monitor\_firepass – Manages F5 BIG-IP GTM FirePass monitors ============================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_monitor_firepass`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP GTM (now BIG-IP DNS) FirePass monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cipher\_list string \| \| Specifies the list of ciphers for this monitor. The items in the cipher list are separated with the colon `:` symbol. When creating a new monitor, if this parameter is not specified, the default list is `HIGH:!ADH`. \| \| concurrency\_limit integer \| \| Specifies the maximum percentage of licensed connections currently in use under which the monitor marks the Secure Access Manager system up. As an example, a setting of 95 percent means that the monitor marks the Secure Access Manager system up until 95 percent of licensed connections are in use. When the number of in-use licensed connections exceeds 95 percent, the monitor marks the Secure Access Manager system down. When creating a new monitor, if this parameter is not specified, the default is `95`. \| \| ignore\_down\_response boolean \| Choices:* no * yes \| Specifies the monitor allows more than one probe attempt per interval. When `yes`, specifies the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down. When `no`, specifies the monitor immediately marks an object down when it receives a down response. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, then the default value will be 30. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. If this value is an IP address, a `port` number must be specified. \| \| max\_load\_average* integer \| \| Specifies the number the monitor uses to mark the Secure Access Manager system up or down. The system compares the Max Load Average setting against a one-minute average of the Secure Access Manager system load. When the Secure Access Manager system-load average falls within the specified Max Load Average, the monitor marks the Secure Access Manager system up. When the average exceeds the setting, the monitor marks the system down. When creating a new monitor, if this parameter is not specified, the default is `12`. \| \| name string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/firepass\_gtm" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `tcp` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. Note that if specifying an IP address, a value between 1 and 65535 must be specified. \| \| probe\_timeout* integer \| \| Specifies the number of seconds after which the system times out the probe request to the system. When creating a new monitor, if this parameter is not provided, the default value will be `5`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password, if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name, if the monitored target requires authentication. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value will be 90. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will update passwords if the `target_password` is specified. `on_create` will only set the password for newly created monitors. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a GTM FirePass monitor bigip_gtm_monitor_firepass: name: my_monitor ip: 1.1.1.1 port: 80 state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove FirePass Monitor bigip_gtm_monitor_firepass: name: my_monitor state: absent provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add FirePass monitor for all addresses, port 514 bigip_gtm_monitor_firepass: name: my_monitor port: 514 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cipher\_list string \| changed \| The new value for the cipher list. Sample: +3DES:+kEDH \| \| concurrency\_limit integer \| changed \| The new value for the concurrency limit. Sample: 95 \| \| ignore\_down\_response boolean \| changed \| Whether to ignore the down response or not. Sample: True \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| max\_load\_average integer \| changed \| The new value for the max load average. Sample: 12 \| \| parent string \| changed \| New parent template of the monitor. Sample: firepass\_gtm \| \| port string \| changed \| The new port the monitor checks the resource on. Sample: 8080 \| \| probe\_timeout integer \| changed \| The new timeout in which the system will timeout the monitor probe. Sample: 10 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_firewall_log_profile_network – Configures Network Firewall related settings of the log profile f5networks.f5\_modules.bigip\_firewall\_log\_profile\_network – Configures Network Firewall related settings of the log profile =============================================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_log_profile_network`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Configures Network Firewall related settings of the log profile. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| log\_format\_delimiter string \| \| Specifies the delimiter string when using a `log_storage_format` of `field-list`. When creating a new profile, if this parameter is not specified, the default value of `,` (the comma character) is used. This option is valid when the `log_storage_format` is set to `field-list`. It is ignored otherwise. Depending on the delimiter used, it may be necessary to wrap the delimiter in quotes to prevent YAML errors from occurring. The special character `$` is reserved for internal use, and will raise an error if used. The maximum length allowed for this parameter is `31` characters. \| \| log\_ip\_errors dictionary \| \| Modifies log settings for logging of IP error packets. \| \| \| enabled boolean \| Choices:* no * yes \| This option enables or disables the logging of IP error packets. \| \| \| rate\_limit integer \| \| This option sets rate limits for the logging of IP error packets. This option is effective only if logging of this message type is enabled. \| \| log\_matches\_accept\_rule dictionary \| \| Modifies log settings for ACL rules configured with an "accept" or "accept decisively" action. \| \| \| enabled boolean \| Choices:* no * yes \| This option enables or disables the logging of packets that match ACL rules configured with an "accept" or "accept decisively" action. \| \| \| rate\_limit integer \| \| This option sets rate limits for the logging of packets that match ACL rules configured with an "accept" or "accept decisively" action. This option is effective only if logging of this message type is enabled. \| \| log\_matches\_drop\_rule dictionary \| \| Modifies log settings for ACL rules configured with a drop action. \| \| \| enabled boolean \| Choices:* no * yes \| This option enables or disables the logging of packets that match ACL rules configured with a drop action. \| \| \| rate\_limit integer \| \| This option sets rate limits for the logging of packets that match ACL rules configured with a drop action. This option is effective only if logging of this message type is enabled. \| \| log\_matches\_reject\_rule dictionary \| \| Modifies log settings for ACL rules configured with a reject action. \| \| \| enabled boolean \| Choices:* no * yes \| This option enables or disables the logging of packets that match ACL rules configured with a reject action. \| \| \| rate\_limit integer \| \| This option sets rate limits for the logging of packets that match ACL rules configured with a reject action. This option is effective only if logging of this message type is enabled. \| \| log\_message\_fields list / elements=string \| Choices:* acl\_policy\_name * acl\_policy\_type * acl\_rule\_name * action * bigip\_hostname * context\_name * context\_type * date\_time * dest\_fqdn * dest\_geo * dest\_ip * dest\_port * drop\_reason * management\_ip\_address * protocol * route\_domain * sa\_translation\_pool * sa\_translation\_type * source\_fqdn * source\_user * src\_geo * src\_ip * src\_port * translated\_dest\_ip * translated\_dest\_port * translated\_ip\_protocol * translated\_route\_domain * translated\_src\_ip * translated\_src\_port * translated\_vlan * vlan \| Specifies a set of fields to be logged. This option is valid when the `log_storage_format` is set to `field-list`. It is ignored otherwise. The order of the list is important, as the server displays the selected traffic items in the log sequentially according to it. \| \| log\_publisher string \| \| Specifies the name of the log publisher used for Network events. To specify the log\_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter. \| \| log\_storage\_format string \| Choices:* field-list * none \| Specifies the type of the storage format. When creating a new log profile, if this parameter is not specified, the default is `none`. When `field-list`, specifies the log displays only the items you specify in the `log_message_fields` list with `log_format_delimiter` as the delimiter between the items. When `none`, the messages will be logged in the default format, which is `"management_ip_address", "bigip_hostname","context_type", "context_name","src_geo","src_ip", "dest_geo","dest_ip","src_port", "dest_port","vlan","protocol","route_domain", "translated_src_ip", "translated_dest_ip", "translated_src_port","translated_dest_port", "translated_vlan","translated_ip_protocol", "translated_route_domain", "acl_policy_type", "acl_policy_name","acl_rule_name","action", "drop_reason","sa_translation_type", "sa_translation_pool","flow_id", "source_user", "source_fqdn","dest_fqdn"`. \| \| log\_tcp\_errors dictionary \| \| Modifies log settings for the logging of TCP error packets. \| \| \| enabled boolean \| Choices:* no * yes \| This option enables or disables the logging of TCP error packets. \| \| \| rate\_limit integer \| \| This option sets rate limits for the logging of TCP error packets. This option is effective only if logging of this message type is enabled. \| \| log\_tcp\_events dictionary \| \| Modifies the log settings for logging of TCP events on the client side. \| \| \| enabled boolean \| Choices:* no * yes \| This option enables or disables the logging of TCP events on the client side. Only Established and Closed states of a TCP session are logged if this option is enabled. \| \| \| rate\_limit integer \| \| This option sets rate limits for the logging of TCP events on the client side. This option is effective only if logging of this message type is enabled. \| \| log\_translation\_fields boolean \| Choices:* no * yes \| This option enables or disables the logging of translated (i.e server side) fields in ACL match and TCP events. Translated fields include (but are not limited to) source address/port, destination address/port, IP protocol, route domain, and VLAN. \| \| partition string \| Default:"Common" \| Device partition to create log profile on. This parameter is also used when specifying names for log publishers, unless log publisher names are in fullpath format. \| \| profile\_name string / required \| \| Specifies the name of the AFM (Advanced Firewall Manager) log profile to be updated. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rate\_limit string \| \| Defines a rate limit for all combined network firewall log messages per second. Beyond this rate limit, log messages are not logged. To specify an indefinite rate, use the value `indefinite`. If specifying a numeric rate, the value must be between `1` and `4294967295`. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the resource exists. The only built-in profile that allows updating network log settings is global-network, attempts to do so on other built-in profiles will be ignored. When `state` is `absent`, ensures that the resource is removed. The `absent` state is ignored for global-network log profile. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add network settings to log profile bigip_firewall_log_profile_network: profile_name: barbaz rate_limit: 150000 log_publisher: local-db-pub log_tcp_errors: enabled: yes rate_limit: 10000 log_tcp_events: enabled: yes rate_limit: 40000 log_storage_format: "field-list" log_message_fields: - vlan - translated_vlan - src_ip provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Change delimiter and log fields bigip_firewall_log_profile_network: profile_name: barbaz log_format_delimiter: '.' log_message_fields: - translated_dest_ip - translated_dest_port provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify built-in profile bigip_firewall_log_profile_network: profile_name: "global-network" log_publisher: "/foobar/log1" log_ip_errors: enabled: yes rate_limit: 60000 log_matches_reject_rule: enabled: yes rate_limit: 2000 log_translation_fields: yes log_storage_format: "field-list" log_format_delimiter: '.' log_message_fields: - protocol - dest_ip - dest_port provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove custom log profile network log settings bigip_firewall_log_profile_network: profile_name: "{{ log_profile }}" state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| log\_format\_delimiter string \| changed \| The delimiter string when using a log\_storage\_format of field-list. Sample: . \| \| log\_ip\_errors complex \| changed \| Log settings for logging of IP error packets. Sample: hash/dictionary of values \| \| \| enabled boolean \| changed \| Enable or disable the logging of IP error packets. Sample: True \| \| \| rate\_limit string \| changed \| The rate limit for the logging of IP error packets. Sample: indefinite \| \| log\_matches\_accept\_rule complex \| changed \| Log settings for ACL rules configured with an "accept" or "accept decisively" action. Sample: hash/dictionary of values \| \| \| enabled boolean \| changed \| Enable or disable the logging of packets that match ACL rules. Sample: True \| \| \| rate\_limit string \| changed \| The rate limit for the logging of packets that match ACL rules. Sample: indefinite \| \| log\_matches\_drop\_rule complex \| changed \| Log settings for ACL rules configured with a drop action. Sample: hash/dictionary of values \| \| \| enabled boolean \| changed \| Enable or disable the logging of packets that match ACL rules. Sample: True \| \| \| rate\_limit string \| changed \| The rate limit for the logging of packets that match ACL rules. Sample: indefinite \| \| log\_matches\_reject\_rule complex \| changed \| Log settings for ACL rules configured with a reject action. Sample: hash/dictionary of values \| \| \| enabled boolean \| changed \| Enable or disable the logging of packets that match ACL rules. Sample: True \| \| \| rate\_limit string \| changed \| The rate limit for the logging of packets that match ACL rules. Sample: indefinite \| \| log\_message\_fields list / elements=string \| changed \| The delimiter string when using a log\_storage\_format of field-list. Sample: ['acl\_policy\_name', 'acl\_policy\_type'] \| \| log\_publisher string \| changed \| The name of the log publisher used for Network events. Sample: /Common/log-publisher \| \| log\_storage\_format string \| changed \| The type of the storage format. Sample: field-list \| \| log\_tcp\_errors complex \| changed \| Log settings for logging of TCP error packets. Sample: hash/dictionary of values \| \| \| enabled boolean \| changed \| Enable or disable the logging of TCP error packets. Sample: True \| \| \| rate\_limit string \| changed \| The rate limit for the logging of TCP error packets. Sample: indefinite \| \| log\_tcp\_events complex \| changed \| Log settings for logging of TCP events on the client side. Sample: hash/dictionary of values \| \| \| enabled boolean \| changed \| Enable or disable the logging of TCP events on the client side. Sample: True \| \| \| rate\_limit string \| changed \| The rate limit for the logging of TCP events on the client side. Sample: indefinite \| \| log\_translation\_fields boolean \| changed \| Enable or disable the logging of translated (i.e server side) fields in ACL match and TCP events. Sample: True \| \| rate\_limit string \| changed \| The rate limit for all combined network firewall log messages per second. Sample: indefinite \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_gtm_topology_record – Manages GTM Topology Records f5networks.f5\_modules.bigip\_gtm\_topology\_record – Manages GTM Topology Records ================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_topology_record`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages GTM (now BIG-IP DNS) Topology Records. Once created, only topology record `weight` can be modified. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| destination dictionary / required \| \| Specifies where the system directs the incoming DNS request. \| \| \| continent string \| \| Specifies one of the seven continents, along with the `Unknown` setting. Specifying `Unknown` forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. Full continent names and their abbreviated versions are supported. \| \| \| country string \| \| Specifies a country. Full continent names and their abbreviated versions are supported. \| \| \| datacenter string \| \| Specifies the name of GTM data center already defined in the configuration. \| \| \| geo\_isp string \| \| Specifies a geolocation ISP \| \| \| isp string \| Choices:* AOL * BeijingCNC * CNC * ChinaEducationNetwork * ChinaMobilNetwork * ChinaRailwayTelcom * ChinaTelecom * ChinaUnicom * Comcast * Earthlink * ShanghaiCNC * ShanghaiTelecom \| Specifies an Internet service provider. \| \| \| negate boolean \| Choices:* no ← * yes \| When set to `yes` the system selects this topology record, when the request destination does not match. \| \| \| pool string \| \| Specifies the name of GTM pool already defined in the configuration. \| \| \| region string \| \| Specifies the name of region already defined in the configuration. \| \| \| state string \| \| Specifies a state in a given country. This parameter requires the `country` option. \| \| \| subnet string \| \| An IP address and network mask in the CIDR format. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. Partition parameter is taken into account when used in conjunction with `pool`, `data_center`, and `region` parameters, otherwise it is ignored. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| source dictionary / required \| \| Specifies the origination of an incoming DNS request. \| \| \| continent string \| \| Specifies one of the seven continents, along with the `Unknown` setting. Specifying `Unknown` forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. Full continent names and their abbreviated versions are supported. \| \| \| country string \| \| Specifies a country. In addition to the country full names, you may also specify their abbreviated form, such as `US` instead of `United States`. Valid country codes can be found here https://countrycode.org/. \| \| \| geo\_isp string \| \| Specifies a geolocation ISP. \| \| \| isp string \| Choices:* AOL * BeijingCNC * CNC * ChinaEducationNetwork * ChinaMobilNetwork * ChinaRailwayTelcom * ChinaTelecom * ChinaUnicom * Comcast * Earthlink * ShanghaiCNC * ShanghaiTelecom \| Specifies an Internet service provider. \| \| \| negate boolean \| Choices:* no ← * yes \| When set to c(yes) the system selects this topology record, when the request source does not match. \| \| \| region string \| \| Specifies the name of region already defined in the configuration. \| \| \| state string \| \| Specifies a state in a given country. This parameter requires the `country` option. \| \| \| subnet string \| \| An IP address and network mask in the CIDR format. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the record exists. When `state` is `absent`, ensures the record is removed. \| \| weight integer \| \| Specifies the weight of the topology record. The system finds the weight of the first topology record that matches the server object (pool or pool member) and the local DNS. The system then assigns that weight as the topology score for that server object. The system load balances to the server object with the highest topology score. If the system finds no topology record that matches both the server object and the local DNS, then the system assigns that server object a zero score. If the option is not specified when the record is created the system will set it at a default value of `1` Valid range is (0 - 4294967295) \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an IP Subnet and an ISP based topology record bigip_gtm_topology_record: source: - subnet: 192.168.1.0/24 destination: - isp: AOL weight: 10 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a region and a pool based topology record bigip_gtm_topology_record: source: - region: Foo destination: - pool: FooPool partition: FooBar provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a negative region and a negative data center based topology record bigip_gtm_topology_record: source: - region: Baz - negate: yes destination: - datacenter: Baz-DC - negate: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| weight integer \| changed \| The weight of the topology record. Sample: 20 \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_qkview – Manage QKviews on the device f5networks.f5\_modules.bigip\_qkview – Manage QKviews on the device =================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_qkview`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages creating and downloading QKviews from a BIG-IP. The qkview utility automatically collects configuration and diagnostic information from BIG-IP systems, and combines the data into a QKView file. F5 Support may request you send or upload this QKview to assist in troubleshooting. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| asm\_request\_log boolean \| Choices:* no ← * yes \| When `true`, includes ASM request log data. When `False`, excludes ASM request log data. \| \| complete\_information boolean \| Choices:* no ← * yes \| Include complete (all applicable) information in the QKview. \| \| dest path / required \| \| Destination on your local filesystem where you want to save the QKview. \| \| exclude list / elements=string \| Choices:* all * audit * secure * bash\_history \| Exclude various file from the QKview. \| \| exclude\_core boolean \| Choices:* no ← * yes \| Exclude core files from the QKview. \| \| filename string \| Default:"localhost.localdomain.qkview" \| Name of the QKview file to create on the remote BIG-IP. \| \| force boolean \| Choices:* no * yes ← \| If `no`, the file will only be transferred if the destination does not exist. \| \| max\_file\_size integer \| Default:0 \| Maximum file size of the QKview file, in bytes. By default, no max file size is specified. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * This module does not include the “max time” or “restrict to blade” options. * If you are using this module with either Ansible Tower or Ansible AWX, you should be aware of how these Ansible products execute jobs in restricted environments. More information can be found here <https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html> * Some longer running tasks might cause the REST interface on BIG-IP to time out, to avoid this adjust the timers as per this KB article <https://support.f5.com/csp/article/K94602685> * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Fetch a qkview from the remote device bigip_qkview: asm_request_log: yes exclude: - audit - secure dest: /tmp/localhost.localdomain.qkview provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_lx_package – Manages Javascript LX packages on a BIG-IP f5networks.f5\_modules.bigip\_lx\_package – Manages Javascript LX packages on a BIG-IP ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_lx_package`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages Javascript LX packages on a BIG-IP. This module allows you to deploy LX packages to the BIG-IP and manage their lifecycle. Requirements ------------ The below requirements are needed on the host that executes this module. * Requires BIG-IP >= 12.1.0 * The ‘rpm’ tool installed on the Ansible controller Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| package path \| \| The LX package that you want to upload or remove. When `state` is `present`, and you intend to use this module in a `role`, we recommend you use the `{{ role_path }}` variable. An example is provided in the `EXAMPLES` section. When `state` is `absent`, it is not necessary for the package to exist on the Ansible controller. If the full path to the package is provided, the fileame will specifically be cherry-picked from it to properly remove the package. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| retain\_package\_file boolean added in 1.4.0 of f5networks.f5\_modules \| Choices:* no ← * yes \| Specifies whether the install file should be deleted on successful installation of the package. \| \| state string \| Choices:* present ← * absent \| Whether the LX package should exist or not. \| Notes ----- Note * Requires the RPM tool be installed on the host. This can be accomplished in different ways on each platform. On Debian based systems with `apt`; `apt-get install rpm`. On Mac with `brew`; `brew install rpm`. This command is already present on RedHat based systems. * Requires BIG-IP >= 12.1.0, because the required functionality is missing on prior versions. * The module name `bigip_iapplx_package` has been deprecated in favor of `bigip_lx_package`. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Install AS3 bigip_lx_package: package: f5-appsvcs-3.5.0-3.noarch.rpm provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Add an LX package stored in a role bigip_lx_package: package: "{{ roles_path }}/files/MyApp-0.1.0-0001.noarch.rpm'" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove an LX package bigip_lx_package: package: MyApp-0.1.0-0001.noarch.rpm state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Install AS3 and don't delete package file bigip_lx_package: package: f5-appsvcs-3.5.0-3.noarch.rpm retain_package_file: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_selfip – Manage Self-IPs on a BIG-IP system f5networks.f5\_modules.bigip\_selfip – Manage Self-IPs on a BIG-IP system ========================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_selfip`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage Self-IP addresses on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| The IP addresses for the new self IP. This value is ignored upon update as addresses themselves cannot be changed after they are created. This value is required when creating new self IPs. \| \| allow\_service list / elements=string \| \| Configure port lockdown for the self IP. By default, the self IP has a "default deny" policy. This can be changed to allow TCP and UDP ports, as well as specific protocols. This list should contain `protocol`:`port` values. \| \| description string \| \| Description of the traffic selector. \| \| fw\_enforced\_policy string added in 1.1.0 of f5networks.f5\_modules \| \| Specifies an AFM policy to attach to Self IP. \| \| name string / required \| \| The name of the self IP to create. If this parameter is not specified, it defaults to the value supplied in the `address` parameter. \| \| netmask string \| \| The netmask for the self IP. When creating a new self IP, this value is required. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. You can set different partitions for self IPs, but the address used may not match any other address used by a self IP. Thus, self IPs are not isolated by partitions as other resources on a BIG-IP are. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| route\_domain integer \| \| The route domain id of the system. When creating a new self IP, if this value is not specified, the default value is `0`. This value cannot be changed after it is set. \| \| state string \| Choices:* absent * present ← \| When `present`, guarantees the self IP exists with the provided attributes. When `absent`, removes the self IP from the system. \| \| traffic\_group string \| \| The traffic group for the self IP addresses in an active-active, redundant load balancer configuration. When creating a new self IP, if this value is not specified, the default is `/Common/traffic-group-local-only`. \| \| vlan string \| \| The VLAN for the new self IPs. When creating a new self IP, this value is required. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create Self IP bigip_selfip: address: 10.10.10.10 name: self1 netmask: 255.255.255.0 vlan: vlan1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create Self IP with a Route Domain bigip_selfip: name: self1 address: 10.10.10.10 netmask: 255.255.255.0 vlan: vlan1 route_domain: 10 allow_service: default provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Delete Self IP bigip_selfip: name: self1 state: absent provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Allow management web UI to be accessed on this Self IP bigip_selfip: name: self1 state: absent allow_service: - tcp:443 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Allow HTTPS and SSH access to this Self IP bigip_selfip: name: self1 state: absent allow_service: - tcp:443 - tcp:22 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Allow all services access to this Self IP bigip_selfip: name: self1 state: absent allow_service: - all provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Allow only GRE and IGMP protocols access to this Self IP bigip_selfip: name: self1 state: absent allow_service: - gre:0 - igmp:0 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Allow all TCP, but no other protocols access to this Self IP bigip_selfip: name: self1 state: absent allow_service: - tcp:0 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address string \| changed \| The address for the self IP. Sample: 192.0.2.10 \| \| allow\_service list / elements=string \| changed \| Services that are allowed via this self IP. Sample: ['igmp:0', 'tcp:22', 'udp:53'] \| \| fw\_enforced\_policy string \| changed \| Specifies an AFM policy to be attached to the self IP. Sample: /Common/afm-blocking-policy \| \| name string \| created \| The name of the self IP. Sample: self1 \| \| netmask string \| changed \| The netmask of the self IP. Sample: 255.255.255.0 \| \| traffic\_group string \| changed \| The traffic group of which the self IP is a member. Sample: traffic-group-local-only \| \| vlan string \| changed \| The VLAN set on the self IP. Sample: vlan1 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_profile_server_ssl – Manages server SSL profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_server\_ssl – Manages server SSL profiles on a BIG-IP ============================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_server_ssl`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages server SSL profiles on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| certificate string \| \| Specifies the name of the certificate the system uses for server-side SSL processing. \| \| chain string \| \| Specifies the certificates-key chain to associate with the SSL profile. \| \| cipher\_group string added in 1.12.0 of f5networks.f5\_modules \| \| Specifies the cipher group to assign to this profile. When the `ciphers` parameter is in use, the `cipher_group` must be set to either `none` or `''`. When creating a new profile with `cipher_group`, if the parent profile has `ciphers` set by default, the `cipher` parameter must be set to `none` or `''` during creation. The parameter only works on TMOS version 13.x and later. \| \| ciphers string \| \| Specifies the list of ciphers the system supports. When creating a new profile, the default cipher list is provided by the parent profile. When the `cipher_group` parameter is in use, the `ciphers` parameter needs to be set to either `none` or `''`. \| \| key string \| \| Specifies the file name of the SSL key. \| \| name string / required \| \| Specifies the name of the profile. \| \| ocsp\_profile string \| \| Specifies the name of the OCSP profile for purpose of validating the status of server certificate. \| \| parent string \| Default:"/Common/serverssl" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| passphrase string \| \| Specifies a passphrase used to encrypt the key. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| renegotiation boolean \| Choices:* no * yes \| Enables or disables SSL renegotiation. When creating a new profile, the setting is provided by the parent profile. \| \| secure\_renegotiation string \| Choices:* require * require-strict * request \| Specifies the method of secure renegotiations for SSL connections. When creating a new profile, the setting is provided by the parent profile. When `request` is set, the system requests secure renegotation of SSL connections. `require` is a default setting and when set, the system permits initial SSL handshakes from clients but terminates renegotiations from unpatched clients. With the `require-strict` setting, the system requires strict renegotiation of SSL connections. In this mode the system refuses connections to insecure servers, and terminates existing SSL connections to insecure servers. \| \| server\_certificate string \| Choices:* ignore * require \| Specifies the way the system handles server certificates. When `ignore`, specifies the system ignores certificates from server systems. When `require`, specifies the system requires a server to present a valid certificate. \| \| server\_name string \| \| Specifies the fully qualified DNS hostname of the server used in Server Name Indication communications. When creating a new profile, the setting is provided by the parent profile. \| \| sni\_default boolean \| Choices:* no * yes \| Indicates the system uses this profile as the default SSL profile when there is no match to the server name, or when the client provides no SNI extension support. When creating a new profile, the setting is provided by the parent profile. There can be only one SSL profile with this setting enabled. \| \| sni\_require boolean \| Choices:* no * yes \| Requires the network peers also provide SNI support. This setting only takes effect when `sni_default` is `yes`. When creating a new profile, the setting is provided by the parent profile. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` allows users to update passwords if they choose to do so. `on_create` only sets the password for newly created profiles. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a new server SSL profile bigip_profile_server_ssl: name: foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create server SSL profile with specific cipher group bigip_profile_server_ssl: state: present name: foo_group ciphers: "none" cipher_group: "/Common/f5-secure" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cipher\_group string \| changed \| The cipher group applied to the profile. Sample: /Common/f5-secure \| \| ciphers string \| changed \| The ciphers applied to the profile. Sample: !SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA \| \| renegotiation boolean \| changed \| Renegotiation of SSL sessions. Sample: True \| \| secure\_renegotiation string \| changed \| The method of secure SSL renegotiation. Sample: request \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_monitor_udp – Manages F5 BIG-IP LTM UDP monitors f5networks.f5\_modules.bigip\_monitor\_udp – Manages F5 BIG-IP LTM UDP monitors =============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_udp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM UDP monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value is 5. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/udp" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `udp` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must specify a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| receive string \| \| The Receive string for the monitor call. \| \| receive\_disable string \| \| This setting works like `receive`, except the system marks the node or pool member disabled when its response matches the `receive_disable` string but not `receive`. To use this setting, you must specify both `receive_disable` and `receive`. \| \| send string \| \| The Send string for the monitor call. When creating a new monitor, if this value is not provided, the default `default send string` is used. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of `0` causes a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, the default value is `0`. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. You can change this to any number, however it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value is 16. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create UDP Monitor bigip_monitor_udp: state: present ip: 10.10.10.10 name: my_udp_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove UDP Monitor bigip_monitor_udp: state: absent name: my_udp_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: http \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_remote_syslog – Manipulate remote syslog settings on a BIG-IP f5networks.f5\_modules.bigip\_remote\_syslog – Manipulate remote syslog settings on a BIG-IP ============================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_remote_syslog`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manipulate remote syslog settings on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| local\_ip string \| \| Specifies the local IP address of the system that is logging. To provide no local IP, specify the value `none`. When creating a remote syslog, if this parameter is not specified, the default value is `none`. \| \| name string \| \| Specifies the name of the syslog object. This option is required when multiple `remote_host`s with the same IP or hostname are present on the device. If `name` is not provided, `remote_host` is used by default. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| remote\_host string / required \| \| Specifies the IP address or hostname for the remote system, to which the system sends log messages. \| \| remote\_port string \| \| Specifies the port the system uses to send messages to the remote logging server. When creating a remote syslog, if this parameter is not specified, the default value is `514`. \| \| state string \| Choices:* absent * present ← \| When `present`, guarantees the remote syslog exists with the provided attributes. When `absent`, removes the remote syslog from the system. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add a remote syslog server to log to bigip_remote_syslog: remote_host: 10.10.10.10 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Add a remote syslog server on a non-standard port to log to bigip_remote_syslog: remote_host: 10.10.10.10 remote_port: 1234 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| local\_ip string \| changed \| The new local IP of the remote syslog server. Sample: 10.10.10.10 \| \| remote\_port integer \| changed \| New remote port of the remote syslog server. Sample: 514 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_file_copy – Manage files in datastores on a BIG-IP f5networks.f5\_modules.bigip\_file\_copy – Manage files in datastores on a BIG-IP ================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_file_copy`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages files on a variety of datastores on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| datastore string \| Choices:* external-monitor * ifile ← * lw4o6-table \| Specifies the datastore to put the file in. There are several different datastores and each of them allows files to be exposed in different ways. When `external-monitor`, the specified file will be stored as an external monitor file and be available for use in external monitors. When `ifile`, the specified file will be stored as an iFile. When `lw4o6-table`, the specified file will be stored as a Lightweight 4 over 6 (lw4o6) tunnel binding table, which includes an IPv6 address for the lwB4, public IPv4 address, and restricted port set. \| \| force boolean \| Choices:* no ← * yes \| Force overwriting a file. By default, files will only be overwritten if the SHA of the file is different for the given filename. This parameter can be used to force overwriting the file even if it already exists and its SHA matches. The `lw4o6-table` datastore does not keep checksums of its file. Therefore, you would need to provide this argument to update any of these files. \| \| name string \| \| The name of the file as it should reside on the BIG-IP. If this is not specified, then the filename provided in the `source` parameter is used instead. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| source path \| \| Specifies the path of the file to upload. This parameter is required if `state` is `present`. aliases: src \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Upload a file as an iFile bigip_file_copy: name: foo source: /path/to/file.txt datastore: ifile provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost # Upload a directory of files - name: Recursively upload web related files in /var/tmp/project find: paths: /var/tmp/project patterns: "^.?\\.(?:html\|?:css\|?:js)$" use_regex: yes register: f - name: Upload a directory of files as a set of iFiles bigip_file_copy: source: "{{ item.path }}" datastore: ifile provider: password: secret server: lb.mydomain.com user: admin loop: f delegate_to: localhost # End upload a directory of files - name: Upload a file to use in an external monitor bigip_file_copy: source: /path/to/files/external.sh datastore: external-monitor provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` ### Authors Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_config – Manage BIG-IP configuration sections f5networks.f5\_modules.bigip\_config – Manage BIG-IP configuration sections =========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_config`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages a BIG-IP configuration by allowing TMSH commands that modify the running configuration, or merge SCF formatted files into the running configuration. Additionally, this module is of significant importance because it allows you to save your running configuration to disk. Since all F5 modules manipulate the running configuration, it is important you use this module to save that running config. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| merge\_content string \| \| Loads the specified configuration that you want to merge into the running configuration. This is equivalent to using the `tmsh` command `load sys config from-terminal merge`. If you need to read the configuration from a file or template, use Ansible's `file` or `template` lookup plugins respectively. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| reset boolean \| Choices:* no ← * yes \| Loads the default configuration on the device. If this option is specified, the default configuration will be loaded before any commands or other provided configuration is run. \| \| save boolean \| Choices:* no * yes ← \| The `save` argument instructs the module to save the running-config to startup-config. This operation is performed after any changes are made to the current running config. If no changes are made, the configuration is still saved to the startup config. This option will always cause the module to return changed. \| \| verify boolean \| Choices:* no ← * yes \| Validates the specified configuration to see whether it is valid to replace the running configuration. The running configuration will not be changed. When this parameter is set to `yes`, no change will be reported by the module. \| Notes ----- Note * This module requires that sys db variable on device `systemauth.disablebash` is set to `false`. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Save the running configuration of the BIG-IP bigip_config: save: yes provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost - name: Reset the BIG-IP configuration, for example, to RMA the device bigip_config: reset: yes save: yes provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost - name: Load an SCF configuration bigip_config: merge_content: "{{ lookup('file', '/path/to/config.scf') }}" provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| stdout list / elements=string \| always \| The set of responses from the options. Sample: ['...', '...'] \| \| stdout\_lines list / elements=string \| always \| The value of stdout split into a list. Sample: [['...', '...'], ['...'], ['...']] \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_gtm_pool_member – Manage GTM pool member settings f5networks.f5\_modules.bigip\_gtm\_pool\_member – Manage GTM pool member settings ================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_pool_member`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages a variety of settings on GTM (now BIG-IP DNS) pool members. The settings that can be adjusted with this module are much more broad that what can be done in the `bigip_gtm_pool` module. The pool module is intended to allow you to adjust the member order in the pool, not the various settings of the members. The `bigip_gtm_pool_member` module should be used to adjust all of the other settings. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| aggregate list / elements=dictionary \| \| List of GTM pool member definitions to be created, modified, or removed. When using `aggregates`, if one of the aggregate definitions is invalid, the aggregate run will fail, indicating the error it last encountered. The module will `NOT` rollback any changes it has made prior to encountering the error. The module also will not indicate what changes were made prior to failure, therefore we strongly advise you run the module in check mode to make basic validation, prior to module execution. aliases: members \| \| description string \| \| The description of the pool member. \| \| limits dictionary \| \| Specifies resource thresholds or limit requirements at the pool member level. When you enable one or more limit settings, the system then uses that data to take members in and out of service. You can define limits for any or all of the limit settings. However, when a member does not meet the resource threshold limit requirement, the system marks the member as unavailable and directs load balancing traffic to another resource. \| \| \| bits\_enabled boolean \| Choices:* no * yes \| Whether the bits limit is enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| bits\_limit integer \| \| Specifies the maximum allowable data throughput rate for the member, in bits per second. If the network traffic volume exceeds this limit, the system marks the member as unavailable. \| \| \| connections\_enabled boolean \| Choices:* no * yes \| Whether the current connections limit is enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| connections\_limit integer \| \| Specifies the maximum number of concurrent connections, combined, for all of the members. If the connections exceed this limit, the system marks the server as unavailable. \| \| \| packets\_enabled boolean \| Choices:* no * yes \| Whether the packets limit is enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| packets\_limit integer \| \| Specifies the maximum allowable data transfer rate for the member, in packets per second. If the network traffic volume exceeds this limit, the system marks the member as unavailable. \| \| member\_order integer \| \| Specifies the order in which the member will appear in the pool. The system uses this number with load balancing methods that involve prioritizing pool members, such as the Ratio load balancing method. When creating a new member using this module, if the `member_order` parameter is not specified, it will default to `0` (first member in the pool). \| \| monitor string \| \| Specifies the monitor assigned to this pool member. Pool members only support a single monitor. If the `port` of the `gtm_virtual_server` is ``, the accepted values of this parameter will be affected. If this parameter is not specified when creating a new pool member, the default of `default` will be used. To remove the monitor from the pool member, use the value `none`. For pool members created on different partitions, you can also specify the full path to the Common monitor. For example, `/Common/tcp`. \| \| partition* string \| Default:"Common" \| Device partition to manage resources on. \| \| pool string / required \| \| Name of the GTM pool. For pools created on different partitions, you must specify partition of the pool in the full path format, for example, `/FooBar/pool_name`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| ratio integer \| \| Specifies the weight of the pool member for load balancing purposes. \| \| replace\_all\_with boolean \| Choices:* no ← * yes \| Removes members not defined in the `aggregate` parameter. This operation is all or none, meaning it will stop if there are some pool members that cannot be removed. aliases: purge \| \| server\_name string \| \| Specifies the GTM server which contains the `virtual_server`. \| \| state string \| Choices:* present ← * absent * enabled * disabled \| Pool member state. When `present`, ensures the pool member is created and enabled. When `absent`, ensures the pool member is removed from the system. When `enabled` or `disabled`, ensures the pool member is enabled or disabled (respectively) on the remote device. We recommend you use the `members` parameter of the `bigip_gtm_pool` module when adding and removing members, as it provides an easier way of specifying order. If this is not possible, the `state` parameter here should be used. Remember that the order of the members will be affected if you add or remove them using this method. To some extent, this can be controlled using the `member_order` parameter. \| \| type string / required \| Choices:* a * aaaa * cname * mx * naptr * srv \| The type of GTM pool that the member is in. \| \| virtual\_server string \| \| Specifies the name of the GTM virtual server which is assigned to the specified `server`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a GTM pool member bigip_gtm_pool_member: pool: pool1 server_name: server1 virtual_server: vs1 type: a provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a GTM pool member different partition bigip_gtm_pool_member: server_name: /Common/foo_name virtual_server: GTMVSName type: a pool: /FooBar/foo-pool partition: Common provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Add GTM pool members aggregate bigip_gtm_pool_member: pool: pool1 type: a aggregate: - server_name: server1 virtual_server: vs1 partition: Common description: web server1 member_order: 0 - server_name: server2 virtual_server: vs2 partition: Common description: web server2 member_order: 1 - server_name: server3 virtual_server: vs3 partition: Common description: web server3 member_order: 2 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add GTM pool members aggregate, remove non aggregates bigip_gtm_pool_member: pool: pool1 type: a aggregate: - server_name: server1 virtual_server: vs1 partition: Common description: web server1 member_order: 0 - server_name: server2 virtual_server: vs2 partition: Common description: web server2 member_order: 1 - server_name: server3 virtual_server: vs3 partition: Common description: web server3 member_order: 2 replace_all_with: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| bits\_enabled boolean \| changed \| Whether the bits limit is enabled. Sample: True \| \| bits\_limit integer \| changed \| The new bits\_enabled limit. Sample: 100 \| \| connections\_enabled boolean \| changed \| Whether the connections limit is enabled. Sample: True \| \| connections\_limit integer \| changed \| The new connections\_limit limit. Sample: 100 \| \| description string \| changed \| The new description of the member. Sample: My description \| \| disabled boolean \| changed \| Whether the pool member is disabled or not. Sample: True \| \| enabled boolean \| changed \| Whether the pool member is enabled or not. Sample: True \| \| member\_order integer \| changed \| The new order in which the member appears in the pool. Sample: 2 \| \| monitor string \| changed \| The new monitor assigned to the pool member. Sample: /Common/monitor1 \| \| packets\_enabled boolean \| changed \| Whether the packets limit is enabled. Sample: True \| \| packets\_limit integer \| changed \| The new packets\_limit limit. Sample: 100 \| \| ratio integer \| changed \| The new weight of the member for load balancing. Sample: 10 \| \| replace\_all\_with boolean \| changed \| Purges all non-aggregate pool members from device Sample: True \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_gtm_dns_listener – Configures the BIG-IP DNS system to answer TCP or UDP DNS requests f5networks.f5\_modules.bigip\_gtm\_dns\_listener – Configures the BIG-IP DNS system to answer TCP or UDP DNS requests ===================================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_dns_listener`. New in version 1.4.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Defines one or more Listener objects to control which protocols are available for the BIG-IP DNS system to process DNS requests. * BIG-IP DNS Listeners allow TCP and UDP protocols. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string / required \| \| Specifies the IP address on which the system listens. \| \| advertise boolean \| Choices:* no * yes \| Specifies whether this Listener's address is advertised to surrounding routers. \| \| auto\_lasthop string \| \| Specifies whether to automatically map the last hop for pools or not. \| \| description string \| \| Provides a brief description for DNS Listener. \| \| disabled\_vlans list / elements=string \| \| List of VLANs to be disabled. If the partition is not specified in the VLAN, then the `partition` option of this module will be used. This parameter is mutually exclusive with the `enabled_vlans` parameters. \| \| enabled\_vlans list / elements=string \| \| List of VLANs to be enabled. When a VLAN named `all` is used, all VLANs will be allowed. VLANs can be specified with or without the leading partition. If the partition is not specified in the VLAN, then the `partition` option of this module will be used. This parameter is mutually exclusive with the `disabled_vlans` parameter. \| \| fallback\_persistence string \| \| Specifies a fallback persistence profile for the Listener to use when the default persistence profile is not available. \| \| ip\_protocol string \| \| Specifies the protocol on which this Listener receives network traffic. \| \| irules list / elements=string \| \| Specifies list of iRules to run on the Listener. iRules help automate the intercepting, processing, and routing of application traffic. If you want to remove existing iRules, provide an empty list value; `[]`. See the documentation for an example. \| \| last\_hop\_pool string \| \| Specifies the name of the last hop pool that you want the Listener to use to direct reply traffic to the last hop router. \| \| mask string \| \| Specifies the netmask for a network Listener only. Netmask clarifies whether the host bit is an actual zero or a wildcard representation. \| \| name string / required \| \| Specifies the name of the DNS Listener. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| pool string \| \| Specifies a default pool to which the Listener automatically directs traffic. \| \| port integer \| \| Specifies the port on which the Listener listens for connections. Valid range of values is between `0` and `65535` inclusive. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| source\_port string \| \| Specifies whether the system preserves the source port of the connection. \| \| state string \| Choices:* present ← * absent * enabled * disabled \| DNS Listener state. When `present`, ensures the pool is created and enabled. When `absent`, ensures the pool is removed from the system. When `enabled` or `disabled`, ensures the pool is enabled or disabled respectively) on the remote device. \| \| translate\_address boolean \| Choices:* no * yes \| Enables or disables address translation for the Listener. \| \| translate\_port boolean \| Choices:* no * yes \| Enables or disables port translation. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: 'Create DNS Listener' bigip_gtm_dns_listener: address: '192.0.1.0' advertise: false auto_lasthop: default description: 'this is a test DNS listener' enabled_vlans: - /Common/external ip_protocol: tcp irules: - /Common/irule1 mask: '255.255.255.0' pool: /Common/webpool name: test-dns-listener port: 30025 provider: password: secret server: lb.mydomain.com user: admin source_port: preserve state: present translate_address: yes translate_port: yes delegate_to: localhost - name: 'Disable a DNS Listener' bigip_gtm_dns_listener: address: '192.0.1.0' state: disabled name: test-dns-listener provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address string \| changed \| IP address on which the system listens. Sample: 10.0.0.2 \| \| advertise boolean \| changed \| Specifies if the Listener advertises to surrounding routers. Sample: True \| \| auto\_lasthop string \| changed \| Shows whether the system automatically maps the last hop for pools. Sample: default \| \| disabled\_vlans list / elements=string \| changed \| List of VLANs the virtual is disabled for. Sample: ['/Common/vlan1', '/Common/vlan2'] \| \| enabled boolean \| changed \| Provides DNS Listener state. Sample: True \| \| enabled\_vlans list / elements=string \| changed \| List of VLANs the virtual is enabled for. Sample: ['/Common/vlan5', '/Common/vlan6'] \| \| fallback\_persistence string \| changed \| Fallback persistence profile for the Listener to use when the default persistence profile is not available. Sample: /Common/fallback-profile \| \| ip\_protocol string \| changed \| IP protocol used by the DNS Listener. Sample: tcp \| \| irules list / elements=string \| changed \| List of rules run by the DNS Listener. Sample: ['/Common/rule1', '/Common/rule2'] \| \| mask string \| changed \| Subnet mask used by the Listener to identify address range. Sample: 255.255.0.0 \| \| name string \| changed \| DNS Listener name. Sample: test-dns-listener \| \| port integer \| changed \| Port on which the system listens. Sample: 53 \| \| source\_port string \| changed \| Specifies if system preserves the source port of the connection. Sample: preserve \| \| translate\_address string \| changed \| Specifies if address translation is enabled. Sample: enabled \| \| translate\_port string \| changed \| Specifies if port translation is enabled. Sample: enabled \| ### Authors * Andrey Kashcheev (@andreykashcheev) ansible f5networks.f5_modules.bigip_gtm_topology_region – Manages GTM Topology Regions f5networks.f5\_modules.bigip\_gtm\_topology\_region – Manages GTM Topology Regions ================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_topology_region`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages GTM (now BIG-IP DNS) Topology Regions. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| name string / required \| \| Specifies the name of the region. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. Partition parameter is also taken into account when used in conjunction with `pool`, `data_center`, and `region` parameters. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| region\_members list / elements=dictionary \| \| Specifies the list of region members. This list of members is all or nothing, in order to add or remove a member, you must specify the entire list of members. The list will override what is on the device, if different. If you specify an empty list, the region members list is removed. \| \| \| continent string \| \| Specifies one of the seven continents, along with the `Unknown` setting. Specifying `Unknown` forces the system to use a default resolution if the system cannot determine the location of the local DNS making the request. Full continent names and their abbreviated versions are supported. \| \| \| country string \| \| The country name or code to use. In addition to the country full names, you may also specify their abbreviated form, such as `US` instead of `United States`. Valid country codes can be found here https://countrycode.org/. \| \| \| datacenter string \| \| Specifies the name of the GTM data center already defined in the configuration. \| \| \| geo\_isp string \| \| Specifies a geolocation ISP. \| \| \| isp string \| Choices:* AOL * BeijingCNC * CNC * ChinaEducationNetwork * ChinaMobilNetwork * ChinaRailwayTelcom * ChinaTelecom * ChinaUnicom * Comcast * Earthlink * ShanghaiCNC * ShanghaiTelecom \| Specifies an Internet service provider. \| \| \| negate boolean \| Choices:* no ← * yes \| When set to c(yes), the system selects this topology region when the request source does not match. Only a single list entry can be specified together with negate. \| \| \| pool string \| \| Specifies the name of the GTM pool already defined in the configuration. \| \| \| region string \| \| Specifies the name of region already defined in the configuration. \| \| \| state string \| \| Specifies a state in a given country. \| \| \| subnet string \| \| An IP address and network mask in the CIDR format. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the region exists. When `state` is `absent`, ensures the region is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create topology region bigip_gtm_topology_region: name: foobar region_members: - country: CN negate: yes - datacenter: baz provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify topology region bigip_gtm_topology_region: name: foobar region_members: - continent: EU - country: PL provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| name string \| changed \| The name value of the GTM region. Sample: foobar \| \| region\_members list / elements=string \| changed \| The list of members of the GTM region. Sample: [{'continent': 'EU'}, {'country': 'PL'}] \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_message_routing_transport_config – Manages configuration for an outgoing connection f5networks.f5\_modules.bigip\_message\_routing\_transport\_config – Manages configuration for an outgoing connection ==================================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_message_routing_transport_config`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages configuration for an outgoing connection in BIG-IP message routing. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The user-defined description of the transport config. \| \| name string / required \| \| Specifies the name of the transport config to manage. \| \| partition string \| Default:"Common" \| Device partition to create transport-config object on. \| \| profiles list / elements=string \| \| Specifies a list of profiles for the outgoing connection to use to direct and manage traffic. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rules list / elements=string \| \| The iRules you want run on this transport config. iRules help automate the intercepting, processing, and routing of application traffic. \| \| src\_addr\_translation dictionary \| \| Specifies the type of source address translation enabled for the transport config and the pool the source address translation will use. \| \| \| pool string \| \| Specifies the name of a LSN or SNAT pool used by the specified transport config. Name can also be specified in `fullPath` format: `/Common/foobar`. When `type` is `none` or `automap`, the pool parameter will be replaced by `none` keyword, thus any defined `pool` parameter will be ignored. \| \| \| type string \| Choices:* snat * none * automap \| Specifies the type of source address translation associated with the specified transport config. When set to `snat`, the `pool` parameter needs to contain a name for a valid LSN or SNAT pool. \| \| src\_port integer \| \| Specifies the source port for the connection being created. If no value is specified an ephemeral port is chosen for the connection being created. The acceptable range is between 0 and 65535 inclusive. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the transport-config object exists. When `absent`, ensures the transport-config object is removed. \| \| type string \| Choices:* generic ← \| Parameter used to specify the type of transport-config object to manage. Default setting is `generic` with more options coming. \| Notes ----- Note * Requires BIG-IP >= 14.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create generic transport config bigip_message_routing_transport_config: name: foo profiles: transport: genericmsg tcp: tcp-lan-optimized description: new_transport provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify generic transport config bigip_message_routing_transport_config: name: foo rules: - rule_1 - rule_2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove generic transport config bigip_message_routing_transport_config: name: foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The user-defined description of the router profile. Sample: My description \| \| profiles list / elements=string \| changed \| The profiles for the outgoing connection . Sample: ['/Common/profile1', '/Common/profile2'] \| \| rules list / elements=string \| changed \| The iRules running on transport config. Sample: ['/Common/rule1', '/Common/rule2'] \| \| source\_port integer \| changed \| The source port for the connection being created. Sample: 10041 \| \| src\_addr\_translation complex \| changed \| The type of source address translation enabled for the transport config. Sample: hash/dictionary of values \| \| \| pool string \| changed \| The name of a LSN or SNAT pool used by the specified transport config. Sample: /Common/pool1 \| \| \| type string \| changed \| the type of source address translation associated with the specified transport config. Sample: automap \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigiq_device_info – Collect information from F5 BIG-IQ devices f5networks.f5\_modules.bigiq\_device\_info – Collect information from F5 BIG-IQ devices ======================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_device_info`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Collect information from F5 BIG-IQ devices. * This module was called `bigiq_device_facts` before Ansible 2.9. The usage did not change. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| gather\_subset list / elements=string / required \| Choices:* all * applications * managed-devices * purchased-pool-licenses * regkey-pools * system-info * vlans * !all * !applications * !managed-devices * !purchased-pool-licenses * !regkey-pools * !system-info * !vlans \| When supplied, this argument restricts the information returned to a given subset. You can specify a list of values to include a larger subset. Values can also be used with an initial `!` to specify a specific subset should not be collected. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * This module is supported with all BIG-IQ versions * With BIGIQ 7.0 and later, a few metadata fields not included/supported (for example, uptime, product\_changelist, product\_jobid) * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Collect BIG-IQ information bigiq_device_info: gather_subset: - system-info - vlans provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Collect all BIG-IQ information bigiq_device_info: gather_subset: - all provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Collect all BIG-IP information except trunks bigiq_device_info: gather_subset: - all - "!trunks" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| applications complex \| When `managed-devices` is specified in `gather_subset`. \| Application related information Sample: hash/dictionary of values \| \| \| active\_alerts integer \| changed \| Number of alerts active on the application. \| \| \| bad\_traffic float \| changed \| Percent of traffic to application that is determined to be 'bad'. This value is dependent on `protection_mode` being enabled. Sample: 1.7498 \| \| \| bad\_traffic\_growth boolean \| changed \| Whether or not Bad Traffic Growth alerts are configured to be triggered or not. \| \| \| connections float \| changed \| Current number of connections established to the application. Sample: 3.06 \| \| \| enhanced\_analytics boolean \| changed \| Whether enhanced analytics is enabled for the application or not. Sample: True \| \| \| health string \| changed \| Health of the application. Sample: Good \| \| \| id string \| changed \| ID of the application as known to the BIG-IQ. Sample: 996baae8-5d1d-3662-8a2d-3612fa2aceae \| \| \| name string \| changed \| Name of the application. Sample: site12http.example.com \| \| \| new\_connections float \| changed \| Number of new connections being established per second. Sample: 0.35 \| \| \| protection\_mode string \| changed \| The type of F5 Web Application Security Service protection on the application. Sample: Not Protected \| \| \| response\_time float \| changed \| Measured response time of the application in milliseconds. Sample: 0.02 \| \| \| status string \| changed \| Current state of the application. Sample: DEPLOYED \| \| \| transactions\_per\_second float \| changed \| Current measurement of Transactions Per second being handled by the application. Sample: 0.87 \| \| managed\_devices complex \| When `managed-devices` is specified in `gather_subset`. \| Managed device related information. Sample: hash/dictionary of values \| \| \| address string \| changed \| Address where the device was discovered. Sample: 10.10.10.10 \| \| \| build string \| changed \| Build of the version. Sample: 0.0.4 \| \| \| device\_uri string \| changed \| URI to reach the management interface of the device. Sample: https://10.10.10.10:443 \| \| \| edition string \| changed \| Edition string of the product version. Sample: Final \| \| \| group\_name string \| changed \| BIG-IQ group that the device is a member of. Sample: cm-bigip-allBigIpDevices \| \| \| hostname string \| changed \| Discovered hostname of the device. Sample: tier2labB1.lab.fp.foo.com \| \| \| https\_port integer \| changed \| HTTPS port available on the management interface of the device. Sample: 443 \| \| \| is\_clustered boolean \| changed \| Whether the device is clustered or not. \| \| \| is\_license\_expired boolean \| changed \| Whether the license on the device is expired or not. Sample: True \| \| \| is\_virtual boolean \| changed \| Whether the device is a virtual edition or not. Sample: True \| \| \| machine\_id string \| changed \| Machine specific ID assigned to this device by BIG-IQ. Sample: c141bc88-f734-4434-be64-a3e9ea98356e \| \| \| management\_address string \| changed \| IP address of the management interface on the device. Sample: 10.10.10.10 \| \| \| mcp\_device\_name string \| changed \| Device name as known by MCPD on the BIG-IP. Sample: /Common/tier2labB1.lab.fp.foo.com \| \| \| product string \| changed \| Product that the managed device is identified as. Sample: BIG-IP \| \| \| rest\_framework\_version string \| changed \| REST framework version running on the device Sample: 13.1.1-0.0.4 \| \| \| self\_link string \| changed \| Internal reference to the managed device in BIG-IQ. Sample: https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e \| \| \| slots dictionary \| changed \| Volumes on the device and versions of software installed in those volumes. Sample: {'build': '0.0.4', 'isActive': 'yes', 'product': 'BIG-IP', 'version': '13.1.1', 'volume': 'HD1.1'} \| \| \| state string \| changed \| State of the device. Sample: ACTIVE \| \| \| tags dictionary \| changed \| Misc tags that are assigned to the device. Sample: {'BIGIQ\_SSG\_name': 'tim-ssg', 'BIGIQ\_tier\_2\_device': '2018-08-22T13:30:47.693-07:00'} \| \| \| trust\_domain\_guid string \| changed \| GUID of the trust domain the device is part of. Sample: 40ddf541-e604-4905-bde3005056813e36 \| \| \| uuid string \| changed \| UUID of the device in BIG-IQ. Sample: c141bc88-f734-4434-be64-a3e9ea98356e \| \| \| version string \| changed \| Version of TMOS installed on the device. Sample: 13.1.1 \| \| purchased\_pool\_licenses complex \| When `purchased-pool-licenses` is specified in `gather_subset`. \| Purchased Pool License related information. Sample: hash/dictionary of values \| \| \| base\_reg\_key string \| changed \| Base registration key of the purchased pool Sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX \| \| \| dossier string \| changed \| Dossier of the purchased pool license Sample: d6bd4b8ba5...e9a1a1199b73af9932948a \| \| \| evaluation\_end\_date\_time string \| changed \| Date that evaluation license ends. Sample: 2018-10-11T00:00:00-07:00 \| \| \| evaluation\_start\_date\_time string \| changed \| Date that evaluation license starts. Sample: 2018-09-09T00:00:00-07:00 \| \| \| free\_device\_licenses integer \| changed \| Number of free licenses remaining. Sample: 34 \| \| \| license\_end\_date\_time string \| changed \| Date that the license expires. Sample: 2018-10-11T00:00:00-07:00 \| \| \| license\_start\_date\_time string \| changed \| Date that the license starts. Sample: 2018-09-09T00:00:00-07:00 \| \| \| licensed\_date\_time string \| changed \| Timestamp that the pool was licensed. Sample: 2018-09-10T00:00:00-07:00 \| \| \| licensed\_version string \| changed \| Version of BIG-IQ that is licensed. Sample: 6.0.1 \| \| \| name string \| changed \| Name of the purchased pool Sample: my-pool1 \| \| \| registration\_key string \| changed \| Purchased pool license key. Sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX \| \| \| state string \| changed \| State of the purchased pool license Sample: LICENSED \| \| \| total\_device\_licenses integer \| changed \| Total number of licenses in the pool. Sample: 40 \| \| \| uuid string \| changed \| UUID of the purchased pool license Sample: b2112329-cba7-4f1f-9a26-fab9be416d60 \| \| \| vendor string \| changed \| Vendor who provided the license Sample: F5 Networks, Inc \| \| regkey\_pools complex \| When `regkey-pools` is specified in `gather_subset`. \| Regkey Pool related information. Sample: hash/dictionary of values \| \| \| id string \| changed \| ID of the regkey pool. Sample: 4f9b565c-0831-4657-b6c2-6dde6182a502 \| \| \| name string \| changed \| Name of the regkey pool. Sample: pool1 \| \| \| offerings complex \| success \| List of the offerings in the pool. Sample: hash/dictionary of values \| \| \| \| dossier string \| changed \| Dossier of the license. Sample: d6bd4b8ba5...e9a1a1199b73af9932948a \| \| \| \| evaluation\_end\_date\_time string \| changed \| Date that evaluation license ends. Sample: 2018-10-11T00:00:00-07:00 \| \| \| \| evaluation\_start\_date\_time string \| changed \| Date that evaluation license starts. Sample: 2018-09-09T00:00:00-07:00 \| \| \| \| license\_end\_date\_time string \| changed \| Date that the license expires. Sample: 2018-10-11T00:00:00-07:00 \| \| \| \| license\_start\_date\_time string \| changed \| Date that the license starts. Sample: 2018-09-09T00:00:00-07:00 \| \| \| \| licensed\_date\_time string \| changed \| Timestamp that the regkey was licensed. Sample: 2018-09-10T00:00:00-07:00 \| \| \| \| licensed\_version string \| changed \| Version of BIG-IQ that is licensed. Sample: 6.0.1 \| \| \| \| name string \| changed \| Name of the regkey. Sample: regkey1 \| \| \| \| registration\_key string \| changed \| Registration license key. Sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX \| \| \| \| state string \| changed \| State of the regkey license Sample: LICENSED \| \| \| total\_offerings integer \| changed \| Total number of offerings in the pool Sample: 10 \| \| system\_info complex \| When `system-info` is specified in `gather_subset`. \| System info related information. Sample: hash/dictionary of values \| \| \| base\_mac\_address string \| changed \| Media Access Control address (MAC address) of the device. Sample: fa:16:3e:c3:42:6f \| \| \| chassis\_serial string \| success \| Serial of the chassis Sample: 11111111-2222-3333-444444444444 \| \| \| hardware\_information complex \| changed \| Information related to the hardware (drives and CPUs) of the system. \| \| \| \| model string \| success \| The model of the hardware. Sample: Virtual Disk \| \| \| \| name string \| success \| The name of the hardware. Sample: HD1 \| \| \| \| type string \| success \| The type of hardware. Sample: physical-disk \| \| \| \| versions complex \| success \| Hardware specific properties \| \| \| \| \| name string \| success \| Name of the property Sample: Size \| \| \| \| \| version string \| success \| Value of the property Sample: 154.00G \| \| \| host\_board\_part\_revision string \| success \| Revision of the host board. \| \| \| host\_board\_serial string \| success \| Serial of the host board. \| \| \| is\_admin\_password\_changed boolean \| changed \| Whether the admin password was changed from its default or not. Sample: True \| \| \| is\_root\_password\_changed boolean \| changed \| Whether the root password was changed from its default or not. \| \| \| is\_system\_setup boolean \| changed \| Whether the system has been setup or not. Sample: True \| \| \| marketing\_name string \| changed \| Marketing name of the device platform. Sample: BIG-IQ Virtual Edition \| \| \| package\_edition string \| changed \| Displays the software edition. Sample: Point Release 7 \| \| \| package\_version string \| success \| A string combining the `product_build` and `product_build_date`. Sample: Build 0.0.1 - Tue May 15 15:26:30 PDT 2018 \| \| \| platform string \| success \| Platform identifier. Sample: Z100 \| \| \| product\_build string \| success \| Build version of the release version. Sample: 0.0.1 \| \| \| product\_build\_date string \| success \| Human readable build date. Sample: Tue May 15 15:26:30 PDT 2018 \| \| \| product\_built integer \| success \| Unix timestamp of when the product was built. Sample: 180515152630 \| \| \| product\_changelist integer \| success \| Changelist that product branches from. Not supported with BIGIQ 7.0 and later versions Sample: 2557198 \| \| \| product\_code string \| success \| Code identifying the product. Sample: BIG-IQ \| \| \| product\_jobid integer \| success \| ID of the job that built the product version. Not supported with BIGIQ 7.0 and later versions Sample: 1012030 \| \| \| product\_version string \| success \| Major product version of the running software. Sample: 6.0.0 \| \| \| switch\_board\_part\_revision string \| success \| Switch board revision. \| \| \| switch\_board\_serial string \| success \| Serial of the switch board. \| \| \| time complex \| changed \| Mapping of the current time information to specific time-named keys. \| \| \| \| day integer \| changed \| The current day of the month, in numeric form. Sample: 7 \| \| \| \| hour integer \| changed \| The current hour of the day in 24-hour form. Sample: 18 \| \| \| \| minute integer \| changed \| The current minute of the hour. Sample: 16 \| \| \| \| month integer \| changed \| The current month, in numeric form. Sample: 6 \| \| \| \| second integer \| changed \| The current second of the minute. Sample: 51 \| \| \| \| year integer \| changed \| The current year in 4-digit form. Sample: 2018 \| \| \| uptime integer \| success \| Time, in seconds, since the system booted. Not supported with BIGIQ 7.0 and later versions Sample: 603202 \| \| vlans complex \| When `vlans` is specified in `gather_subset`. \| List of VLAN information. Sample: hash/dictionary of values \| \| \| auto\_lasthop string \| changed \| Allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. Sample: enabled \| \| \| cmp\_hash\_algorithm string \| changed \| Specifies how the traffic on the VLAN will be disaggregated. Sample: default \| \| \| description string \| changed \| Description of the VLAN. Sample: My vlan \| \| \| failsafe\_action string \| changed \| Action for the system to take when the fail-safe mechanism is triggered. Sample: reboot \| \| \| failsafe\_enabled boolean \| changed \| Whether failsafe is enabled or not. Sample: True \| \| \| failsafe\_timeout integer \| changed \| Number of seconds that an active unit can run without detecting network traffic on this VLAN before it starts a failover. Sample: 90 \| \| \| if\_index integer \| changed \| Index assigned to this VLAN. It is a unique identifier assigned for all objects displayed in the SNMP IF-MIB. Sample: 176 \| \| \| interfaces complex \| changed \| List of tagged or untagged interfaces and trunks that you want to configure for the VLAN. \| \| \| \| full\_path string \| changed \| Full name of the resource as known to BIG-IP. Sample: 1.3 \| \| \| \| name string \| changed \| Relative name of the resource in BIG-IP. Sample: 1.3 \| \| \| \| tagged boolean \| changed \| Whether the interface is tagged or not. \| \| \| learning\_mode string \| changed \| Whether switch ports placed in the VLAN are configured for switch learning, forwarding only, or dropped. Sample: enable-forward \| \| \| mtu integer \| changed \| Specific maximum transition unit (MTU) for the VLAN. Sample: 1500 \| \| \| sflow\_poll\_interval integer \| changed \| Maximum interval in seconds between two pollings. \| \| \| sflow\_poll\_interval\_global boolean \| changed \| Whether the global VLAN poll-interval setting, overrides the object-level poll-interval setting. \| \| \| sflow\_sampling\_rate integer \| changed \| Ratio of packets observed to the samples generated. \| \| \| sflow\_sampling\_rate\_global boolean \| changed \| Whether the global VLAN sampling-rate setting, overrides the object-level sampling-rate setting. Sample: True \| \| \| source\_check\_enabled boolean \| changed \| Specifies that only connections that have a return route in the routing table are accepted. Sample: True \| \| \| tag integer \| changed \| Tag number for the VLAN. Sample: 30 \| \| \| true\_mac\_address string \| changed \| Media access control (MAC) address for the lowest-numbered interface assigned to this VLAN. Sample: fa:16:3e:10:da:ff \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_firewall_dos_vector – Manage attack vector configuration in an AFM DoS profile f5networks.f5\_modules.bigip\_firewall\_dos\_vector – Manage attack vector configuration in an AFM DoS profile ============================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_dos_vector`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the attack vector configuration in an AFM (Advanced Firewall Manager) DoS profile. In addition to the normal AFM DoS profile vectors, this module can manage the device-configuration vectors. See the module documentation for details about this method. Requirements ------------ The below requirements are needed on the host that executes this module. * BIG-IP >= v13.0.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allow\_advertisement boolean \| Choices:* no * yes \| Specifies addresses that are identified for blacklisting are advertised to BGP routers. \| \| attack\_ceiling string \| \| Specifies the absolute maximum allowable for packets of this type. This setting rate limits packets to the packets per second setting, when specified. To set no hard limit and allow automatic thresholds to manage all rate limiting, set this to `infinite`. \| \| attack\_floor string \| \| Specifies packets per second to identify an attack. These settings provide an absolute minimum of packets to allow before the attack is identified. As the automatic detection thresholds adjust to traffic and CPU usage on the system over time, this attack floor becomes less relevant. This value may not exceed the value in `attack_floor`. \| \| auto\_blacklist boolean \| Choices:* no * yes \| Automatically blacklists detected bad actors. To enable this parameter, the `bad_actor_detection` must also be enabled. This parameter is not supported by the `dns-malformed` vector. This parameter is not supported by the `qdcount` vector. \| \| bad\_actor\_detection boolean \| Choices:* no * yes \| Whether Bad Actor detection is enabled or disabled for a vector, if available. This parameter must be enabled to enable the `auto_blacklist` parameter. This parameter is not supported by the `dns-malformed` vector. This parameter is not supported by the `qdcount` vector. \| \| blacklist\_detection\_seconds integer \| \| Detection before blacklisting occurs, in seconds. \| \| blacklist\_duration integer \| \| Duration the blacklist will last, in seconds. \| \| detection\_threshold\_eps string \| \| Lists how many packets per second the system must discover in traffic in order to detect this attack. aliases: rate\_threshold \| \| detection\_threshold\_percent string \| \| Lists the threshold percent increase over time that the system must detect in traffic in order to detect this attack. The `tcp-half-open` vector does not support this parameter. aliases: rate\_increase \| \| mitigation\_threshold\_eps string \| \| Specifies the maximum number of this type of packet per second the system allows for a vector. The system drops packets once the traffic level exceeds the rate limit. aliases: rate\_limit \| \| name string / required \| Choices:* bad-icmp-chksum * bad-icmp-frame * bad-igmp-frame * bad-ip-opt * bad-ipv6-hop-cnt * bad-ipv6-ver * bad-sctp-chksum * bad-tcp-chksum * bad-tcp-flags-all-clr * bad-tcp-flags-all-set * bad-ttl-val * bad-udp-chksum * bad-udp-hdr * bad-ver * arp-flood * flood * igmp-flood * igmp-frag-flood * ip-bad-src * ip-err-chksum * ip-len-gt-l2-len * ip-other-frag * ip-overlap-frag * ip-short-frag * ip-uncommon-proto * ip-unk-prot * ipv4-mapped-ipv6 * ipv6-atomic-frag * ipv6-bad-src * ipv6-len-gt-l2-len * ipv6-other-frag * ipv6-overlap-frag * ipv6-short-frag * l2-len-ggt-ip-len * l4-ext-hdrs-go-end * land-attack * no-l4 * no-listener-match * non-tcp-connection * payload-len-ls-l2-len * routing-header-type-0 * syn-and-fin-set * tcp-ack-flood * tcp-hdr-len-gt-l2-len * tcp-hdr-len-too-short * hdr-len-gt-l2-len * hdr-len-too-short * bad-ext-hdr-order * ext-hdr-too-large * hop-cnt-low * host-unreachable * icmp-frag * icmp-frame-too-large * icmpv4-flood * icmpv6-flood * ip-frag-flood * ip-low-ttl * ip-opt-frames * ipv6-ext-hdr-frames * ipv6-frag-flood * opt-present-with-illegal-len * sweep * tcp-bad-urg * tcp-half-open * tcp-opt-overruns-tcp-hdr * tcp-psh-flood * tcp-rst-flood * tcp-syn-flood * tcp-syn-oversize * tcp-synack-flood * tcp-window-size * tidcmp * too-many-ext-hdrs * dup-ext-hdr * fin-only-set * ether-brdcst-pkt * ether-multicst-pkt * ether-mac-sa-eq-da * udp-flood * unk-ipopt-type * unk-tcp-opt-type * a * aaaa * any * axfr * cname * dns-malformed * dns-nxdomain-query * dns-response-flood * dns-oversize * ixfr * mx * ns * other * ptr * qdcount * soa * srv * txt * ack * bye * cancel * invite * message * notify * options * other * prack * publish * register * sip-malformed * subscribe * uri-limit \| Specifies the name of the vector to modify. Vectors that ship with the device are "hard-coded" in that the list of vectors is known to the system and users cannot add new vectors. Users only manipulate the existing vectors; all of which are disabled by default. When `bad-icmp-chksum`, configures the "Bad ICMP Checksum" Network Security vector. When `bad-icmp-frame`, configures the "Bad ICMP Frame" Network Security vector. When `bad-igmp-frame`, configures the "Bad IGMP Frame" Network Security vector. When `bad-ip-opt`, configures the "IP Option Illegal Length" Network Security vector. When `bad-ipv6-hop-cnt`, configures the "Bad IPv6 Hop Count" Network Security vector. When `bad-ipv6-ver`, configures the "Bad IPv6 Version" Network Security vector. When `bad-sctp-chksum`, configures the "Bad SCTP Checksum" Network Security vector. When `bad-tcp-chksum`, configures the "Bad TCP Checksum" Network Security vector. When `bad-tcp-flags-all-clr`, configures the "Bad TCP Flags (All Cleared)" Network Security vector. When `bad-tcp-flags-all-set`, configures the "Bad TCP Flags (All Flags Set)" Network Security vector. When `bad-ttl-val`, configures the "Bad IP TTL Value" Network Security vector. When `bad-udp-chksum`, configures the "Bad UDP Checksum" Network Security vector. When `bad-udp-hdr`, configures the "Bad UDP Header (UDP Length > IP Length or L2 Length)" Network Security vector. When `bad-ver`, configures the "Bad IP Version" Network Security vector. When `arp-flood`, configures the "ARP Flood" Network Security vector. When `flood`, configures the "Single Endpoint Flood" Network Security vector. When `igmp-flood`, configures the "IGMP Flood" Network Security vector. When `igmp-frag-flood`, configures the "IGMP Fragment Flood" Network Security vector. When `ip-bad-src`, configures the "Bad Source" Network Security vector. When `ip-err-chksum`, configures the "IP Error Checksum" Network Security vector. When `ip-len-gt-l2-len`, configures the "IP Length > L2 Length" Network Security vector. When `ip-other-frag`, configures the "IP Fragment Error" Network Security vector. When `ip-overlap-frag`, configures the "IP Fragment Overlap" Network Security vector. When `ip-short-frag`, configures the "IP Fragment Too Small" Network Security vector. When `ip-uncommon-proto`, configures the "IP Uncommon Proto" Network Security vector. When `ip-unk-prot`, configures the "IP Unknown Protocol" Network Security vector. When `ipv4-mapped-ipv6`, configures the "IPv4 Mapped IPv6" Network Security vector. When `ipv6-atomic-frag`, configures the "IPv6 Atomic Fragment" Network Security vector. When `ipv6-bad-src`, configures the "Bad IPv6 Addr" Network Security vector. When `ipv6-len-gt-l2-len`, configures the "IPv6 Length > L2 Length" Network Security vector. When `ipv6-other-frag`, configures the "IPv6 Fragment Error" Network Security vector. When `ipv6-overlap-frag`, configures the "IPv6 Fragment Overlap" Network Security vector. When `ipv6-short-frag`, configures the "IPv6 Fragment Too Small" Network Security vector. When `l2-len-ggt-ip-len`, configures the "L2 Length >> IP Length" Network Security vector. When `l4-ext-hdrs-go-end`, configures the "No L4 (Extension Headers Go To Or Past The End of Frame)" Network Security vector. When `land-attack`, configures the "LAND Attack" Network Security vector. When `no-l4`, configures the "No L4" Network Security vector. When `no-listener-match`, configures the "No Listener Match" Network Security vector. When `non-tcp-connection`, configures the "Non TCP Connection" Network Security vector. When `payload-len-ls-l2-len`, configures the "Payload Length < L2 Length" Network Security vector. When `routing-header-type-0`, configures the "Routing Header Type 0" Network Security vector. When `syn-and-fin-set`, configures the "SYN && FIN Set" Network Security vector. When `tcp-ack-flood`, configures the "TCP BADACK Flood" Network Security vector. When `tcp-hdr-len-gt-l2-len`, configures the "TCP Header Length > L2 Length" Network Security vector. When `tcp-hdr-len-too-short`, configures the "TCP Header Length Too Short (Length < 5)" Network Security vector. When `hdr-len-gt-l2-len`, configures the "Header Length > L2 Length" Network Security vector. When `hdr-len-too-short`, configures the "Header Length Too Short" Network Security vector. When `bad-ext-hdr-order`, configures the "IPv6 Extended Headers Wrong order" Network Security vector. When `ext-hdr-too-large`, configures the "IPv6 extension header too large" Network Security vector. When `hop-cnt-low`, configures the "IPv6 hop count <= <tunable>" Network Security vector. When `host-unreachable`, configures the "Host Unreachable" Network Security vector. When `icmp-frag`, configures the "ICMP Fragment" Network Security vector. When `icmp-frame-too-large`, configures the "ICMP Frame Too Large" Network Security vector. When `icmpv4-flood`, configures the "ICMPv4 flood" Network Security vector. When `icmpv6-flood`, configures the "ICMPv6 flood" Network Security vector. When `ip-frag-flood`, configures the "IP Fragment Flood" Network Security vector. When `ip-low-ttl`, configures the "TTL <= <tunable>" Network Security vector. When `ip-opt-frames`, configures the "IP Option Frames" Network Security vector. When `ipv6-ext-hdr-frames`, configures the "IPv6 Extended Header Frames" Network Security vector. When `ipv6-frag-flood`, configures the "IPv6 Fragment Flood" Network Security vector. When `opt-present-with-illegal-len`, configures the "Option Present With Illegal Length" Network Security vector. When `sweep`, configures the "Sweep" Network Security vector. When `tcp-bad-urg`, configures the "TCP Flags-Bad URG" Network Security vector. When `tcp-half-open`, configures the "TCP Half Open" Network Security vector. When `tcp-opt-overruns-tcp-hdr`, configures the "TCP Option Overruns TCP Header" Network Security vector. When `tcp-psh-flood`, configures the "TCP PUSH Flood" Network Security vector. When `tcp-rst-flood`, configures the "TCP RST Flood" Network Security vector. When `tcp-syn-flood`, configures the "TCP SYN Flood" Network Security vector. When `tcp-syn-oversize`, configures the "TCP SYN Oversize" Network Security vector. When `tcp-synack-flood`, configures the "TCP SYN ACK Flood" Network Security vector. When `tcp-window-size`, configures the "TCP Window Size" Network Security vector. When `tidcmp`, configures the "TIDCMP" Network Security vector. When `too-many-ext-hdrs`, configures the "Too Many Extension Headers" Network Security vector. When `dup-ext-hdr`, configures the "IPv6 Duplicate Extension Headers" Network Security vector. When `fin-only-set`, configures the "FIN Only Set" Network Security vector. When `ether-brdcst-pkt`, configures the "Ethernet Broadcast Packet" Network Security vector. When `ether-multicst-pkt`, configures the "Ethernet Multicast Packet" Network Security vector. When `ether-mac-sa-eq-da`, configures the "Ethernet MAC Source Address == Destination Address" Network Security vector. When `udp-flood`, configures the "UDP Flood" Network Security vector. When `unk-ipopt-type`, configures the "Unknown Option Type" Network Security vector. When `unk-tcp-opt-type`, configures the "Unknown TCP Option Type" Network Security vector. When `a`, configures the "DNS A Query" DNS Protocol Security vector. When `aaaa`, configures the "DNS AAAA Query" DNS Protocol Security vector. When `any`, configures the "DNS ANY Query" DNS Protocol Security vector. When `axfr`, configures the "DNS AXFR Query" DNS Protocol Security vector. When `cname`, configures the "DNS CNAME Query" DNS Protocol Security vector. When `dns-malformed`, configures the "dns-malformed" DNS Protocol Security vector. When `dns-nxdomain-query`, configures the "dns-nxdomain-query" DNS Protocol Security vector. When `dns-response-flood`, configures the "dns-response-flood" DNS Protocol Security vector. When `dns-oversize`, configures the "dns-oversize" DNS Protocol Security vector. When `ixfr`, configures the "DNS IXFR Query" DNS Protocol Security vector. When `mx`, configures the "DNS MX Query" DNS Protocol Security vector. When `ns`, configures the "DNS NS Query" DNS Protocol Security vector. When `other`, configures the "DNS OTHER Query" DNS Protocol Security vector. When `ptr`, configures the "DNS PTR Query" DNS Protocol Security vector. When `qdcount`, configures the "DNS QDCOUNT Query" DNS Protocol Security vector. When `soa`, configures the "DNS SOA Query" DNS Protocol Security vector. When `srv`, configures the "DNS SRV Query" DNS Protocol Security vector. When `txt`, configures the "DNS TXT Query" DNS Protocol Security vector. When `ack`, configures the "SIP ACK Method" SIP Protocol Security vector. When `bye`, configures the "SIP BYE Method" SIP Protocol Security vector. When `cancel`, configures the "SIP CANCEL Method" SIP Protocol Security vector. When `invite`, configures the "SIP INVITE Method" SIP Protocol Security vector. When `message`, configures the "SIP MESSAGE Method" SIP Protocol Security vector. When `notify`, configures the "SIP NOTIFY Method" SIP Protocol Security vector. When `options`, configures the "SIP OPTIONS Method" SIP Protocol Security vector. When `other`, configures the "SIP OTHER Method" SIP Protocol Security vector. When `prack`, configures the "SIP PRACK Method" SIP Protocol Security vector. When `publish`, configures the "SIP PUBLISH Method" SIP Protocol Security vector. When `register`, configures the "SIP REGISTER Method" SIP Protocol Security vector. When `sip-malformed`, configures the "sip-malformed" SIP Protocol Security vector. When `subscribe`, configures the "SIP SUBSCRIBE Method" SIP Protocol Security vector. When `uri-limit`, configures the "uri-limit" SIP Protocol Security vector. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| per\_source\_ip\_detection\_threshold string \| \| Specifies the number of packets per second to identify an IP address as a bad actor. \| \| per\_source\_ip\_mitigation\_threshold string \| \| Specifies the rate limit applied to a source IP that is identified as a bad actor. \| \| profile string / required \| \| Specifies the name of the profile to manage vectors in. The name `device-config` is reserved for use by this module. Vectors can be managed in either DoS Profiles or Device Configuration. By specifying a profile of 'device-config', this module will specifically tailor configuration of the provided vectors to the Device Configuration. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| simulate\_auto\_threshold boolean \| Choices:* no * yes \| Specifies results of the current automatic thresholds are logged, though manual thresholds are enforced, and no action is taken on automatic thresholds. The `sweep` vector does not support this parameter. \| \| state string \| Choices:* mitigate * detect-only * learn-only * disabled \| When `state` is `mitigate`, ensures the vector enforces limits and thresholds. When `state` is `detect-only`, ensures the vector does not enforce limits and thresholds (rate limiting, dropping, etc), but is still tracked in logs and statistics. When `state` is `disabled`, ensures the vector does not enforce limits and thresholds, but is still tracked in logs and statistics. When `state` is `learn-only`, ensures the vector does not "detect" any attacks. Only learning and stat collecting is performed. \| \| threshold\_mode string \| Choices:* manual * stress-based-mitigation * fully-automatic \| The `dns-malformed` vector does not support `fully-automatic` or `stress-based-mitigation` for this parameter. The `qdcount` vector does not support `fully-automatic` or `stress-based-mitigation` for this parameter. The `sip-malformed` vector does not support `fully-automatic` or `stress-based-mitigation` for this parameter. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Enable DNS AAAA vector mitigation bigip_firewall_dos_vector: name: aaaa state: mitigate provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| allow\_advertisement boolean \| changed \| The new Allow External Advertisement setting. Sample: True \| \| attack\_ceiling string \| changed \| The new Attack Ceiling EPS setting. Sample: infinite \| \| attack\_floor string \| changed \| The new Attack Floor EPS setting. Sample: infinite \| \| auto\_blacklist boolean \| changed \| The new Auto Blacklist setting. \| \| bad\_actor\_detection boolean \| changed \| The new Bad Actor Detection setting. \| \| blacklist\_category string \| changed \| The new Category Name setting. Sample: /Common/cloud\_provider\_networks \| \| blacklist\_detection\_seconds integer \| changed \| The new Sustained Attack Detection Time setting. Sample: 60 \| \| blacklist\_duration integer \| changed \| The new Category Duration Time setting. Sample: 14400 \| \| detection\_threshold\_eps string \| changed \| The new Detection Threshold EPS setting. Sample: infinite \| \| detection\_threshold\_percent string \| changed \| The new Detection Threshold Percent setting. Sample: infinite \| \| mitigation\_threshold\_eps string \| changed \| The new Mitigation Threshold EPS setting. Sample: infinite \| \| per\_source\_ip\_detection\_threshold string \| changed \| The new Per Source IP Detection Threshold EPS setting. Sample: 23 \| \| per\_source\_ip\_mitigation\_threshold string \| changed \| The new Per Source IP Mitigation Threshold EPS setting. Sample: infinite \| \| simulate\_auto\_threshold boolean \| changed \| The new Simulate Auto Threshold setting. \| \| state string \| changed \| The new state of the vector. Sample: mitigate \| \| threshold\_mode string \| changed \| The new Mitigation Threshold EPS setting. Sample: infinite \| ### Authors * Tim Rupp (@caphrim007) * Nitin Khanna (@nitinthewiz)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_dns – Manage DNS monitors on a BIG-IP f5networks.f5\_modules.bigip\_monitor\_dns – Manage DNS monitors on a BIG-IP ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_dns`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages DNS health monitors on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accept\_rcode string \| Choices:* no-error * anything \| Specifies the RCODE required in the response for an up status. When creating a new monitor, if this parameter is not specified, the default value is `no-error`. When `no-error`, specifies the status of the node will be marked up if the received DNS message has no error. When `anything`, specifies the status of the node will be marked up irrespective of the RCODE in the DNS message received. If this parameter is set to `anything`, it will disregard the `receive` string, and nullify it if the monitor is being updated. \| \| adaptive boolean \| Choices:* no * yes \| Specifies whether adaptive response time monitoring is enabled for this monitor. When `yes`, the monitor determines the state of a service based on how divergent from the mean latency a monitor probe for that service is allowed to be. Also, values for the `allowed_divergence`, `adaptive_limit`, and and `sampling_timespan` will be enforced. When `disabled`, the monitor determines the state of a service based on the `interval`, `up_interval`, `time_until_up`, and `timeout` monitor settings. \| \| adaptive\_limit integer \| \| Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of `allowed_divergence` setting, for a probe to be considered successful. This value applies regardless of the value of the `allowed_divergence` setting. While this value can be configured when `adaptive` is `no`, it will not take effect on the system until `adaptive` is `yes`. \| \| allowed\_divergence\_type string \| Choices:* relative * absolute \| When specifying a new monitor, if `adaptive` is `yes`, the default is `relative`. When `absolute`, the number of milliseconds the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. In typical cases, if the monitor detects three probes in a row that miss the latency value you set, the pool member or node is marked down. When `relative`, the percentage of deviation the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. \| \| allowed\_divergence\_value integer \| \| When specifying a new monitor, if `adaptive` is `yes`, and `type` is `relative`, the default is `25` percent. \| \| answer\_section\_contains string \| Choices:* any-type * anything * query-type \| Specifies the type of DNS query the monitor sends. When creating a new monitor, if this value is not specified, the default value is `query-type`. When `query-type`, specifies that the response should contain at least one answer of which the resource record type matches the query type. When `any-type`, specifies the DNS message should contain at least one answer. When `anything`, specifies an empty answer is enough to mark the status of the node up. \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. This value must be less than the `timeout` value. When creating a new monitor, if this parameter is not provided, the default `5` will be used. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be ``. \| \| manual\_resume* boolean \| Choices:* no * yes \| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If `yes`, you must manually re-enable the resource before the system can use it for load balancing connections. When creating a new monitor, if this parameter is not specified, the default value is `no`. When `yes`, specifies you must manually re-enable the resource after an unsuccessful monitor check. When `no`, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. \| \| name string / required \| \| Specifies the name of the monitor. \| \| parent string \| Default:"/Common/dns" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `dns` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be ``. Note that if specifying an IP address, you must use a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| query\_name string \| \| Specifies a query name for the monitor to use in a DNS query. \| \| query\_type string \| Choices:* a * aaaa \| Specifies the type of DNS query the monitor sends. When creating a new monitor, if this parameter is not specified, the default value is `a`. When `a`, specifies the monitor will send a DNS query of type A. When `aaaa`, specifies the monitor will send a DNS query of type AAAA. \| \| receive string \| \| Specifies the IP address the monitor uses from the resource record sections of the DNS response. The IP address should be specified in the dotted-decimal notation or IPv6 notation. \| \| reverse boolean \| Choices:* no * yes \| Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up. You can use the this mode only if you configure the `receive` option. This parameter is not compatible with the `time_until_up` parameter. If `time_until_up` is specified, it must be `0`. Or, if it already exists, it must be `0`. \| \| sampling\_timespan integer \| \| Specifies the length, in seconds, of the probe history window the system uses to calculate the mean latency and standard deviation of a monitor probe. While this value can be configured when `adaptive` is `no`, it will not take effect on the system until `adaptive` is `yes`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, the default value will be `0`. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value will be `16`. \| \| transparent boolean \| Choices:* no * yes \| Specifies whether the monitor operates in transparent mode. Monitors in transparent mode can monitor pool members through firewalls. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| \| up\_interval integer \| \| Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. When creating a new monitor, if this parameter is not provided, the default `0` will be used. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a DNS monitor bigip_monitor_dns: name: DNS-UDP-V6 interval: 2 query_name: localhost query_type: aaaa up_interval: 5 adaptive: no state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| accept\_rcode string \| changed \| RCODE required in the response for an up status. Sample: no-error \| \| adaptive boolean \| changed \| Whether adaptive is enabled or not. Sample: True \| \| adaptive\_limit integer \| changed \| Absolute number of milliseconds that may not be exceeded by a monitor probe. Sample: 200 \| \| allowed\_divergence\_type string \| changed \| Type of divergence used for adaptive response time monitoring. Sample: absolute \| \| allowed\_divergence\_value integer \| changed \| Value of the type of divergence used for adaptive response time monitoring. May be `percent` or `ms` depending on whether `relative` or `absolute`. Sample: 25 \| \| answer\_section\_contains string \| changed \| Type of DNS query that the monitor sends. Sample: query-type \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| manual\_resume string \| changed \| Whether the system automatically changes the status of a resource to enabled at the next successful monitor check. Sample: query-type \| \| parent string \| changed \| New parent template of the monitor. Sample: http \| \| port string \| changed \| Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Sample: 80 \| \| query\_name string \| changed \| Query name for the monitor to use in a DNS query. Sample: foo \| \| query\_type string \| changed \| Type of DNS query the monitor sends. Either `a` or `aaaa`. Sample: aaaa \| \| receive string \| changed \| IP address the monitor uses from the resource record sections of the DNS response. Sample: 2.3.2.4 \| \| reverse boolean \| changed \| Whether the monitor operates in reverse mode. Sample: True \| \| sampling\_timespan integer \| changed \| Absolute number of milliseconds that may not be exceeded by a monitor probe. Sample: 200 \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| transparent boolean \| changed \| Whether the monitor operates in transparent mode. \| \| up\_interval integer \| changed \| Interval for the system to use to perform the health check when a resource is up. \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_ucs_fetch – Fetches a UCS file from remote nodes f5networks.f5\_modules.bigip\_ucs\_fetch – Fetches a UCS file from remote nodes =============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ucs_fetch`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module is used for fetching UCS files from remote machines and storing them locally in a file tree, organized by hostname. This module was written to create and transfer UCS files that might not be present, it does not require UCS file to be pre-created. So a missing remote UCS is not an error unless `fail_on_missing` is set to ‘yes’. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| async\_timeout integer \| Default:150 \| Parameter used when creating new UCS file on a device. The amount of time to wait for the API async interface to complete its task, in seconds. The accepted value range is between `150` and `1800` seconds. \| \| backup boolean \| Choices:* no ← * yes \| Creates a backup file including the timestamp information so you can get the original file back if you overwrote it incorrectly. \| \| create\_on\_missing boolean \| Choices:* no * yes ← \| Creates the UCS based on the value of `src`, if the file does not already exist on the remote system. \| \| dest path \| \| A directory to save the UCS file into. This option is mandatory when `only_create_file` is set to `no`. \| \| encryption\_password string \| \| Password to use to encrypt the UCS file if desired. \| \| fail\_on\_missing boolean \| Choices:* no ← * yes \| Make the module fail if the UCS file on the remote system is missing. \| \| force boolean \| Choices:* no * yes ← \| If `no`, the file is only transferred if the destination does not exist. \| \| only\_create\_file boolean added in 1.12.0 of f5networks.f5\_modules \| Choices:* no ← * yes \| If `yes`, the file is created on device and not downloaded. If the UCS archive exists on device, no change is made and file is not be downloaded. To recreate UCS files left on the device, remove them with `bigip_ucs` module before running this module with `only_create_file` set to `yes`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| src string \| \| The name of the UCS file to create on the remote server for downloading. The file is retrieved or created in /var/local/ucs/. This option is mandatory when `only_create_file` is set to `yes`. \| Notes ----- Note * BIG-IP provides no way to get a checksum of the UCS files on the system via any interface with the possible exception of logging in directly to the box (which would not support appliance mode). Therefore, the best this module can do is check for the existence of the file on disk; no check-summing. * If you are using this module with either Ansible Tower or Ansible AWX, you should be aware of how these Ansible products execute jobs in restricted environments. More information can be found here <https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html> * Some longer running tasks might cause the REST interface on BIG-IP to time out, to avoid this adjust the timers as per this KB article <https://support.f5.com/csp/article/K94602685> * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Download a new UCS bigip_ucs_fetch: src: cs_backup.ucs dest: /tmp/cs_backup.ucs provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Only create new UCS, no download bigip_ucs_fetch: src: cs_backup.ucs only_create_file: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Recreate UCS file left on device - remove file first bigip_ucs: ucs: cs_backup.ucs state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Recreate UCS file left on device - create new file bigip_ucs_fetch: src: cs_backup.ucs only_create_file: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| backup\_file string \| changed and if backup=yes \| Name of the backup file. Sample: /path/to/file.txt.2015-02-12@22:09~ \| \| checksum string \| success or changed \| The SHA1 checksum of the downloaded file. Sample: 7b46bbe4f8ebfee64761b5313855618f64c64109 \| \| dest string \| success \| Location on the ansible host the UCS was saved to. Sample: /path/to/file.txt \| \| gid integer \| success \| Group ID of the UCS file, after execution. Sample: 100 \| \| group string \| success \| Group of the UCS file, after execution. Sample: httpd \| \| md5sum string \| changed or success \| The MD5 checksum of the downloaded file. Sample: 96cacab4c259c4598727d7cf2ceb3b45 \| \| mode string \| success \| Permissions of the target UCS, after execution. Sample: 420 \| \| owner string \| success \| Owner of the UCS file, after execution. Sample: httpd \| \| size integer \| success \| Size of the target UCS, after execution. Sample: 1220 \| \| src string \| changed \| Name of the UCS file on the remote BIG-IP to download. If not specified, this is a randomly generated filename. Sample: cs\_backup.ucs \| \| uid integer \| success \| Owner ID of the UCS file, after execution. Sample: 100 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_gtm_monitor_tcp_half_open – Manages F5 BIG-IP GTM TCP half-open monitors f5networks.f5\_modules.bigip\_gtm\_monitor\_tcp\_half\_open – Manages F5 BIG-IP GTM TCP half-open monitors ========================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_monitor_tcp_half_open`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP GTM (now BIG-IP DNS) TCP half-open monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| ignore\_down\_response boolean \| Choices:* no * yes \| Specifies that the monitor allows more than one probe attempt per interval. When `yes`, specifies the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down. When `no`, specifies the monitor immediately marks an object down when it receives a down response. When creating a new monitor, if this parameter is not provided, then the default value will be `no`. \| \| interval integer \| \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. When creating a new monitor, if this parameter is not provided, then the default value will be `30`. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/tcp\_half\_open" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `tcp_half_open` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. Note that if using an IP address, you must specify a value between 1 and 65535. \| \| probe\_attempts* integer \| \| Specifies the number of times the system attempts to probe the host server, after which the system considers the host server down or unavailable. When creating a new monitor, if this parameter is not provided, the default value will be `3`. \| \| probe\_interval integer \| \| Specifies the number of seconds the big3d process waits before sending out a subsequent probe attempt when a probe fails and multiple probe attempts have been requested. When creating a new monitor, if this parameter is not provided, then the default value will be `1`. \| \| probe\_timeout integer \| \| Specifies the number of seconds after which the system times out the probe request to the system. When creating a new monitor, if this parameter is not provided, the default value will be `5`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| timeout integer \| \| Specifies the number of seconds the target has in which to respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. When this value is set to 0 (zero), the system uses the interval from the parent monitor. When creating a new monitor, if this parameter is not provided, the default value will be `120`. \| \| transparent boolean \| Choices:* no * yes \| Specifies whether the monitor operates in transparent mode. A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the `ip`-`port` combination specified in the monitor). If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create TCP half-open Monitor bigip_gtm_monitor_tcp_half_open: state: present ip: 10.10.10.10 name: my_monitor provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove TCP half-open Monitor bigip_gtm_monitor_tcp_half_open: state: absent name: my_monitor provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add half-open monitor for all addresses, port 514 bigip_gtm_monitor_tcp_half_open: port: 514 name: my_monitor provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: tcp\_half\_open \| \| probe\_attempts integer \| changed \| The new number of attempts the system will make in checking the monitor probe. Sample: 10 \| \| probe\_interval integer \| changed \| The new interval in which the system will check the monitor probe. Sample: 10 \| \| probe\_timeout integer \| changed \| The new timeout in which the system will timeout the monitor probe. Sample: 10 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_ssl_key_cert – Import/Delete SSL keys and certs from BIG-IP f5networks.f5\_modules.bigip\_ssl\_key\_cert – Import/Delete SSL keys and certs from BIG-IP =========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ssl_key_cert`. New in version 1.6.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * This module imports/deletes SSL keys and certificates on a BIG-IP. Keys can be imported from key files on the local disk, in PEM format. Certificates can be imported from certificate and key files on the local disk, in PEM format. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert\_content string \| \| Sets the contents of a certificate directly to the specified value. This is used with lookup plugins or for anything with formatting or `content` must be provided when `state` is `present`. \| \| cert\_name string \| \| SSL Certificate Name. This is the cert name used when importing a certificate into the BIG-IP. It also determines the filenames of the objects on the LTM. \| \| issuer\_cert string \| \| Issuer certificate used for OCSP monitoring. This parameter is only valid on versions of BIG-IP 13.0.0 or above. \| \| key\_content string \| \| Sets the contents of a key directly to the specified value. This is used with lookup plugins, or for anything with formatting or templating. This must be provided when `state` is `present`. \| \| key\_name string \| \| The name of the key. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| passphrase string \| \| Passphrase on key. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the key and/or cert is uploaded to the device. When `absent`, ensures the key and/or cert is removed from the device. If the key and/or cert is currently in use, the module will not be able to remove the key. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Import both key and cert bigip_ssl_key_cert: key_content: "{{ lookup('file', 'key.pem') }}" key_name: cert1 cert_content: "{{ lookup('file', 'cert.pem') }}" cert_name: cert1 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` ### Authors * Nitin Khanna (@nitinthewiz) ansible f5networks.f5_modules.bigip_cli_alias – Manage CLI aliases on a BIG-IP f5networks.f5\_modules.bigip\_cli\_alias – Manage CLI aliases on a BIG-IP ========================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_cli_alias`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Allows for managing both private and shared aliases on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| command string \| \| The command to alias. \| \| description string \| \| Description of the alias. \| \| name string / required \| \| Specifies the name of the alias. \| \| partition string \| Default:"Common" \| Device partition on which to manage resources. This parameter is disregarded when the `scope` is `private`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| scope string \| Choices:* private * shared ← \| The scope of the alias; whether it is shared on the system, or usable only for the user who created it. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a new alias bigip_cli_alias: name: sync_device_to_bside scope: shared command: save /sys config partitions all; run /cm config-sync to-group device-group-1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| command string \| changed \| The new command that is aliased. Sample: run /util bash \| \| description string \| changed \| The new description of the alias. Sample: Run the bash shell \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigiq_application_fastl4_tcp – Manages BIG-IQ FastL4 TCP applications f5networks.f5\_modules.bigiq\_application\_fastl4\_tcp – Manages BIG-IQ FastL4 TCP applications =============================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_application_fastl4_tcp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IQ applications used for load balancing a TCP-based application with a FastL4 profile. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| add\_analytics boolean \| Choices:* no ← * yes \| Collects statistics of the BIG-IP to which the application is deployed. This parameter is only relevant when specifying a `service_environment` which is a BIG-IP; not an SSG. \| \| description string \| \| Description of the application. \| \| inbound\_virtual dictionary \| \| Settings to configure the virtual which will receive the inbound connection. \| \| \| address string / required \| \| Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. \| \| \| netmask string / required \| \| Specifies the netmask to associate with the given `destination`. This parameter is required when creating a new application. \| \| \| port string \| Default:8080 \| The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is `8080`. \| \| name string / required \| \| Name of the new application. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| servers list / elements=dictionary \| \| A list of servers on which the application is hosted. If you are familiar with other BIG-IP settings, you might also refer to this list as the list of pool members. When creating a new application, at least one server is required. \| \| \| address string / required \| \| The IP address of the server. \| \| \| port string \| Default:8000 \| The port of the server. When creating a new application and specifying a server, if this parameter is not provided, the default is `8000`. \| \| service\_environment string \| \| Specifies the name of service environment to which the application is deployed. When creating a new application, this parameter is required. The service environment type is automatically discovered by this module. Therefore, it is crucial that you maintain unique names for items in the different service environment types. SSGs are not supported for this type of application. \| \| state string \| Choices:* absent * present ← \| The state of the resource on the system. When `present`, guarantees the resource exists with the provided attributes. When `absent`, removes the resource from the system. \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the application to be created, deleted, or updated. \| Notes ----- Note * This module does not support updating of your application (whether deployed or not). If you need to update the application, we recommend removing and re-creating it. * This module will not work on BIG-IQ version 6.1.x or greater. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Load balance a TCP-based application with a FastL4 profile bigiq_application_fastl4_tcp: name: my-app description: My description service_environment: my-bigip-device servers: - address: 1.2.3.4 port: 8080 - address: 5.6.7.8 port: 8080 inbound_virtual: name: foo address: 2.2.2.2 netmask: 255.255.255.255 port: 443 provider: password: secret server: lb.mydomain.com user: admin state: present delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the application of the resource. Sample: My application \| \| inbound\_virtual\_destination string \| changed \| The destination of the virtual that was created. Sample: 6.7.8.9 \| \| inbound\_virtual\_netmask string \| changed \| The network mask of the provided inbound destination. Sample: 255.255.255.0 \| \| inbound\_virtual\_port integer \| changed \| The port on which the inbound virtual address listens. Sample: 80 \| \| servers complex \| changed \| List of servers, and their ports, that make up the application. Sample: hash/dictionary of values \| \| \| address string \| changed \| The IP address of the server. Sample: 2.3.4.5 \| \| \| port integer \| changed \| The port on which the server listens. Sample: 8080 \| \| service\_environment string \| changed \| The environment to which the service was deployed. Sample: my-ssg1 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigiq_application_https_offload – Manages BIG-IQ HTTPS offload applications f5networks.f5\_modules.bigiq\_application\_https\_offload – Manages BIG-IQ HTTPS offload applications ===================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_application_https_offload`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IQ applications used for load balancing an HTTPS application on port 443 with SSL offloading on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| add\_analytics boolean \| Choices:* no ← * yes \| Collects statistics of the BIG-IP to which the application is deployed. This parameter is only relevant when specifying a `service_environment` which is a BIG-IP; not an SSG. \| \| client\_ssl\_profile dictionary \| \| Specifies the SSL profile for managing client-side SSL traffic. \| \| \| cert\_key\_chain raw \| \| One or more certificates and keys to associate with the SSL profile. This option is always a list. The keys in the list dictate the details of the client/key/chain/passphrase combination. BIG-IPs can only have one of each type of each certificate/key type. This means you can only have one RSA, one DSA, and one ECDSA per profile. If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo, the device rejects it. This list is a complex list that specifies a number of keys. When creating a new profile, if this parameter is not specified, the default value is `inherit`. \| \| \| \| cert string \| \| Specifies a cert name for use. \| \| \| \| chain string \| \| Specifies a certificate chain that is relevant to the specified certificate and key. This key is optional. \| \| \| \| key string \| \| Specifies a key name. \| \| \| \| passphrase string \| \| Contains the passphrase of the key file, should it require one. Passphrases are encrypted on the remote BIG-IP device. \| \| \| name string \| Default:"clientssl" \| The name of the client SSL profile to created and used. When creating a new application, if this value is not specified, the default value is `clientssl`. \| \| description string \| \| Description of the application. \| \| inbound\_virtual dictionary \| \| Settings to configure the virtual which receives the inbound connection. This virtual is used to host the HTTPS endpoint of the application. Traffic destined to the `redirect_virtual` is offloaded to this parameter to ensure proper redirection from insecure to secure occurs. \| \| \| address string / required \| \| Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. \| \| \| netmask string / required \| \| Specifies the netmask to associate with the given `address`. This parameter is required when creating a new application. \| \| \| port string \| Default:443 \| The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is `443`. \| \| name string / required \| \| Name of the new application. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| redirect\_virtual dictionary \| \| Settings to configure the virtual which receives the connection to be redirected. This virtual is used to host the HTTP endpoint of the application. Traffic destined to this parameter is offloaded to the `inbound_virtual` parameter to ensure proper redirection from insecure to secure occurs. \| \| \| address string / required \| \| Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. \| \| \| netmask string / required \| \| Specifies the netmask to associate with the given `address`. This parameter is required when creating a new application. \| \| \| port string \| Default:80 \| The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is `80`. \| \| servers list / elements=dictionary \| \| A list of servers on which the application is hosted. If you are familiar with other BIG-IP settings, you might also refer to this list as the list of pool members. When creating a new application, at least one server is required. \| \| \| address string / required \| \| The IP address of the server. \| \| \| port string \| Default:80 \| The port of the server. \| \| service\_environment string \| \| Specifies the name of service environment or the hostname of the BIG-IP to which the application will be deployed. When creating a new application, this parameter is required. \| \| state string \| Choices:* absent * present ← \| The state of the resource on the system. When `present`, guarantees the resource exists with the provided attributes. When `absent`, removes the resource from the system. \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the application to be created, deleted or updated. \| Notes ----- Note * This module will not work on BIGIQ version 6.1.x or greater. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Load balance an HTTPS application on port 443 with SSL offloading on BIG-IP bigiq_application_https_offload: name: my-app description: Redirect HTTP to HTTPS service_environment: my-ssg servers: - address: 1.2.3.4 port: 8080 - address: 5.6.7.8 port: 8080 inbound_virtual: address: 2.2.2.2 netmask: 255.255.255.255 port: 443 redirect_virtual: address: 2.2.2.2 netmask: 255.255.255.255 port: 80 provider: password: secret server: lb.mydomain.com user: admin state: present delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the application of the resource. Sample: My application \| \| inbound\_virtual\_destination string \| changed \| The destination of the virtual that was created. Sample: 6.7.8.9 \| \| inbound\_virtual\_netmask string \| changed \| The network mask of the provided inbound destination. Sample: 255.255.255.0 \| \| inbound\_virtual\_port integer \| changed \| The port on which the inbound virtual address listens. Sample: 80 \| \| servers complex \| changed \| List of servers, and their ports, that make up the application. Sample: hash/dictionary of values \| \| \| address string \| changed \| The IP address of the server. Sample: 2.3.4.5 \| \| \| port integer \| changed \| The port on which the server listens. Sample: 8080 \| \| service\_environment string \| changed \| The environment to which the service was deployed. Sample: my-ssg1 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigiq_license – Select a random license key from a pool of biqiq available licenses f5networks.f5\_modules.bigiq\_license – Select a random license key from a pool of biqiq available licenses =========================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_license`. New in version 1.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Select a random license key from a pool of biqiq available licenses ,Requires specifying BIGIQ license pool name and connection parameters Examples -------- ``` - name: Get a regkey license from a license pool bigiq_regkey_license: key: "{{ lookup('f5networks.f5_modules.bigiq_license', pool_name='foo_pool', username=baz, password=bar, host=192.168.1.1, port=10443}}" state: present pool: foo_pool - name: Get a regkey license from a license pool, use default credentials and port, disable SSL verification bigiq_regkey_license: key: "{{ lookup('f5networks.f5_modules.bigiq_license', pool_name='foo_pool', host=192.168.1.1, validate_certs=false}}" state: present pool: foo_pool ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this lookup: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| \_raw string \| success \| random item \| ### Authors * Wojciech Wypior <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#6116474255575a161811080e13474252565a474254535a474255595a0754474255575a020e0c)>	programming_docs
ansible f5networks.f5_modules.bigip_profile_udp – Manage UDP profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_udp – Manage UDP profiles on a BIG-IP ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_udp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage UDP profiles on a BIG-IP system. There are many UDP profiles, each with their own adjustments to the standard `udp` profile. Users of this module should be aware that many of the available options have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| datagram\_load\_balancing boolean \| Choices:* no * yes \| When `yes`, specifies the system load balances UDP traffic packet-by-packet. \| \| idle\_timeout string \| \| Specifies the length of time a connection is idle (has no traffic) before the connection is eligible for deletion. When creating a new profile, if this parameter is not specified, the remote device will choose a default value appropriate for the profile, based on its `parent` profile. When a number is specified, indicates the number of seconds the UDP connection can remain idle before the system deletes it. When `indefinite`, specifies UDP connections can remain idle indefinitely. When `0` or `immediate`, specifies you do not want the UDP connection to remain idle, and it is therefore immediately eligible for deletion. \| \| name string / required \| \| Specifies the name of the profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `udp` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a TCP profile bigip_profile_tcp: name: foo parent: udp idle_timeout: 300 datagram_load_balancing: no state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| datagram\_load\_balancing boolean \| changed \| The new datagram load balancing setting of the resource. Sample: True \| \| idle\_timeout integer \| changed \| The new idle timeout of the resource. Sample: 100 \| \| parent string \| changed \| The new parent of the resource. Sample: udp \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_network_globals – Manage network global settings on BIG-IP f5networks.f5\_modules.bigip\_network\_globals – Manage network global settings on BIG-IP ========================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_network_globals`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Module to manage STP, Multicast, DAG, LLDP and Self Allow global settings on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| dag dictionary \| \| Manage global disaggregation settings. \| \| \| dag\_ipv6\_prefix\_len integer \| \| Specifies whether SPDAG or IPv6 prefix DAG should be used to disaggregate IPv6 traffic when vlan cmp hash is set to `src-ip` or `dst-ip`. The valid value range is 0 - 128, with `128` value SPAG is in use. This option is only available in TMOS version `13.x` and above. \| \| \| icmp\_hash string \| Choices:* icmp * ipicmp \| Specifies the ICMP hash for ICMP echo request and ICMP echo reply in SW DAG. When `icmp`, ICMP echo request and ICMP echo reply are disaggregated based on ICMP id. When `ipicmp`, ICMP echo request and ICMP echo reply are disaggregated based on ICMP id and IP addresses. This option is only available in `TMOS` version `13.x` and above. \| \| \| round\_robin\_mode string \| Choices:* global * local \| Specifies whether the round robin disaggregator (DAG) on a blade can disaggregate packets to all the TMMs in the system or only to the TMMs local to the blade. When `global`, the DAG will disaggregate packets to all TMMs in the system. When `local`, the DAG will disaggregate packets only to the TMMs local to the blade. \| \| lldp dictionary \| \| Manage LLDP configuration options. \| \| \| enabled boolean \| Choices:* no * yes \| Specifies the current status of LLDP. When `yes`, the LLDP is enabled globally on the device. When `no`, the LLDP is disabled globally on the device. \| \| \| max\_neighbors\_per\_port integer \| \| Specifies the maximum number of neighbors per port. The valid value range is 0 - 65535. \| \| \| reinit\_delay integer \| \| Specifies the maximum number of seconds to wait after reaching the TTL interval before resetting TTL timer. The valid value range is 0 - 65535. \| \| \| tx\_delay integer \| \| Specifies the number of seconds to wait for LLDP to initialize on an interface before sending LLDP message. The valid value range is 0 - 65535. \| \| \| tx\_hold integer \| \| Specifies the multiplier that determines the LLDP Time to Live (TTL). TTL is determined by multiplying this value and `tx_interval`. The valid value range is 0 - 65535. \| \| \| tx\_interval integer \| \| Specifies the interval devices use to send LLDP information from each of their interfaces. The valid value range is 0 - 65535. \| \| multicast dictionary \| \| Manage multicast traffic configuration options. \| \| \| max\_pending\_packets integer \| \| Specifies the maximum number of packet queued on behalf of a single incomplete MFC entry. The valid range is 0 - 4294967295. \| \| \| max\_pending\_routes integer \| \| Specifies the number of incomplete MFC entries each TMM will allow to exist at one time. The valid range is 0 - 4294967295. \| \| \| rate\_limit boolean \| Choices:* no * yes \| When `yes`, the DB variable `switchboard.maxmcastrate` setting controls the multicast packet per second rate limiting in the switch. \| \| \| route\_lookup\_timeout integer \| \| Specifies maximum lifetime of an incomplete MFC entry, in seconds. The valid range is 0 - 4294967295. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| self\_allow dictionary added in 1.1.0 of f5networks.f5\_modules \| \| Manage Self Allow global configuration options. \| \| \| all boolean \| Choices:* no * yes \| Sets all or none ports and protocols as a system wide `self_allow` setting. When `yes`, the self\_allow allows all protocols and ports. This is the equivalent of setting all option in `TMSH`. When `no`, the self\_allow allows no protocols and ports. This is the equivalent of setting none option in `TMSH`. \| \| \| defaults list / elements=dictionary \| \| The default set of protocols and ports allowed by a self IP if the self IP allow-service setting is default. \| \| \| \| port integer \| \| The port number to be set. The valid value range is 0 - 65535. \| \| \| \| protocol string \| \| The protocol name to be set. \| \| stp dictionary \| \| Manage global settings for STP on BIG-IP. \| \| \| config\_name string \| \| Specifies the configuration name. The accepted length is from 1 to 32 characters. Only has effect when the `mode` is `mstp`. \| \| \| config\_revision integer \| \| Specifies the revision level of the MSTP configuration, when `mode` is `mstp`. You must specify a number in the range of 0 to 65535. \| \| \| description string \| \| User-defined description. \| \| \| fwd\_delay integer \| \| The number of seconds for which an interface was blocked from forwarding network traffic after a reconfiguration of the spanning tree topology. This parameter has no effect when `rstp` or `mstp` modes are used, as long as all bridges in the spanning tree use the RSTP or MSTP protocol. If any legacy STP bridges are present, neighboring bridges must fall back to the old protocol, whose reconfiguration time is affected by the forward delay value. The valid range is 4 to 30. \| \| \| hello\_time integer \| \| Specifies the time interval in seconds between the periodic transmissions that communicate spanning tree information to the adjacent bridges in the network. The hello time set by default on the device is optimal in virtually all cases. F5 recommends that you do not change the hello time. The valid range is 1 to 10. \| \| \| max\_age integer \| \| Specifies the number of seconds for which spanning tree information received from other bridges is considered valid. The valid range is 6 to 40 seconds. \| \| \| max\_hops integer \| \| Specifies the maximum number of hops an MSTP packet may travel before it is discarded. This option only takes effect when `mode` is `mstp`. The number of hops must be in the range of 1 to 255. \| \| \| mode string \| Choices:* disabled * mstp * passthru * rstp * stp \| Specifies the spanning tree mode. The `mstp`, `rstp` and `stp` options are only supported on hardware platforms. Attempting to set these modes on VE type platforms will result in failure. The only valid options on VE type platforms are: `passthru` and `disabled`. \| \| \| transmit\_hold integer \| \| Specifies the absolute limit on the number of spanning tree protocol packets the traffic management system may transmit on a port in any hello time interval. The valid range is 1 to 10 packets. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Update STP settings bigip_network_globals: stp: config_name: foobar config_revision: 1 max_hops: 20 mode: mstp provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update DAG settings bigip_network_globals: dag: icmp_hash: ipicmp round_robin_mode: local provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update multiple settings bigip_network_globals: stp: config_name: foobar config_revision: 1 max_hops: 20 mode: mstp dag: icmp_hash: ipicmp round_robin_mode: local provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| dag complex \| changed \| Manage multicast traffic configuration options. Sample: hash/dictionary of values \| \| \| dag\_ipv6\_prefix\_len integer \| changed \| Specifies whether SPDAG or IPv6 prefix DAG should be used to disaggregate IPv6 traffic. Sample: 128 \| \| \| icmp\_hash string \| changed \| Specifies the ICMP hash for the ICMP echo request and ICMP echo reply in SW DAG. Sample: ipicmp \| \| \| round\_robin\_mode string \| changed \| The mode of operation of the DAG on a blade. Sample: local \| \| lldp complex \| changed \| Manage multicast traffic configuration options. Sample: hash/dictionary of values \| \| \| enabled boolean \| changed \| The current status of LLDP. Sample: True \| \| \| max\_neighbors\_per\_port integer \| changed \| The maximum number of neighbors per port. Sample: 128 \| \| \| reinit\_delay integer \| changed \| The maximum number of seconds to wait before resetting the TTL timer after reaching the TTL interval. Sample: 30 \| \| \| tx\_delay integer \| changed \| The number of seconds to wait for LLDP to initialize on an interface before sending LLDP message. Sample: 500 \| \| \| tx\_hold integer \| changed \| The multiplier that determines the LLDP Time to Live. Sample: 10 \| \| \| tx\_interval integer \| changed \| The interval devices use to send LLDP information from each of their interfaces. Sample: 240 \| \| multicast complex \| changed \| Manage multicast traffic configuration options. Sample: hash/dictionary of values \| \| \| max\_pending\_packets integer \| changed \| The maximum number of packet queued on behalf of a single incomplete MFC entry. Sample: 3000 \| \| \| max\_pending\_routes integer \| changed \| The number of incomplete MFC entries each TMM will allow to exist at one time. Sample: 50 \| \| \| rate\_limit boolean \| changed \| Enables DB variable control over multicast packet per second rate limiting in the switch. Sample: True \| \| \| route\_lookup\_timeout integer \| changed \| The maximum lifetime of an incomplete MFC entry, in seconds. Sample: 20 \| \| self\_allow complex \| changed \| Manages self\_allow system wide settings. Sample: hash/dictionary of values \| \| \| all boolean \| changed \| Allows all or none ports and protocols as a system wide self\_allow setting. Sample: True \| \| \| defaults complex \| changed \| The default set of protocols and ports allowed by a self IP. Sample: hash/dictionary of values \| \| \| \| port integer \| changed \| The port number to be set. Sample: 443 \| \| \| \| protocol string \| changed \| The protocol name to be set. Sample: tcp \| \| stp complex \| changed \| Manage global settings for STP on BIG-IP. Sample: hash/dictionary of values \| \| \| config\_name string \| changed \| The configuration name. Sample: foobar \| \| \| config\_revision integer \| changed \| The revision level of the MSTP configuration. Sample: 2 \| \| \| description string \| changed \| User-defined description. Sample: My description \| \| \| fwd\_delay integer \| changed \| The number of seconds for which an interface was blocked from forwarding network traffic. Sample: 4 \| \| \| hello\_time integer \| changed \| The time interval at seconds between the periodic transmissions of spanning tree information. Sample: 2 \| \| \| max\_age integer \| changed \| The number of seconds that spanning tree information received from other bridges is considered valid. Sample: 30 \| \| \| max\_hops integer \| changed \| The maximum number of hops an MSTP packet may travel before it is discarded. Sample: 15 \| \| \| mode string \| changed \| The spanning tree mode. Sample: mstp \| \| \| transmit\_hold integer \| changed \| The limit on the number of STP the traffic management system may transmit on a port in any hello time interval. Sample: 5 \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigiq_regkey_pool – Manages registration key pools on BIG-IQ f5networks.f5\_modules.bigiq\_regkey\_pool – Manages registration key pools on BIG-IQ ===================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_regkey_pool`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages registration key (regkey) pools on a BIG-IQ. These pools function as a container in which you add lists of registration keys. To add registration keys, use the `bigiq_regkey_license` module. Requirements ------------ The below requirements are needed on the host that executes this module. * BIG-IQ >= 5.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| A description to attach to the pool. \| \| name string / required \| \| Specifies the name of the registration key pool. You must name your registration pools unique names. While BIG-IQ does not require this, this module does. If you do not, the behavior of the module is undefined, and you may end up putting licenses in the wrong registration key pool. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* absent * present ← \| The state of the regkey pool on the system. When `present`, guarantees the pool exists. When `absent`, removes the pool, and the licenses it contains, from the system. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a registration key (regkey) pool to hold individual device licenses bigiq_regkey_pool: name: foo-pool state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| New description of the regkey pool. Sample: My description \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_firewall_schedule – Manage BIG-IP AFM schedule configurations f5networks.f5\_modules.bigip\_firewall\_schedule – Manage BIG-IP AFM schedule configurations ============================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_schedule`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP AFM (Avanced Firewall Manager) schedule configurations. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| daily\_hour\_end string \| \| Specifies the time of day the rule will stop being used. When not defined, the default of `24:00` is used when creating a new schedule. The time zone is always assumed to be UTC and values must be provided as `HH:MM` using 24hour clock format. \| \| daily\_hour\_start string \| \| Specifies the time of day the rule will start to be in use. The value must be a time before `daily_hour_end`. When not defined, the default of `0:00` is used when creating a new schedule. When the value is set to `all-day` both `daily_hour_end` and `daily_hour_start` are reset to their respective defaults. The time zone is always assumed to be UTC and values must be provided as `HH:MM` using 24hour clock format. \| \| date\_valid\_end string \| \| Specifies the end date/time this schedule will apply to the rule. The date must be after `date_valid_start` When not defined, the default of `indefinite` is used when creating a new schedule. The time zone is always assumed to be UTC. The datetime format should always be in `YYYY-MM-DD:HH:MM:SS` format. \| \| date\_valid\_start string \| \| Specifies the start date/time this schedule will apply to the rule. When not defined the default of `epoch` is used when creating a new schedule. The time zone is always assumed to be UTC. The datetime format should always be in `YYYY-MM-DD:HH:MM:SS` format. \| \| days\_of\_week list / elements=string \| Choices:* sunday * monday * tuesday * wednesday * thursday * friday * saturday * all \| Specifies which days of the week the rule will be applied. When not defined, the default value of `all` is used when creating a new schedule. The `all` value is mutually exclusive with other choices. \| \| description string \| \| Specifies the user defined description text. \| \| name string / required \| \| Specifies the name of the AFM schedule configuration. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a 6 hour two day schedule, no start/end date bigip_firewall_schedule: name: barfoo daily_hour_start: 13:00 daily_hour_end: 19:00 days_of_week: - monday - tuesday provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a seven day schedule with start/end date bigip_firewall_schedule: name: foobar date_valid_start: "{{ lookup('pipe','date +%Y-%m-%d:%H:%M:%S') }}" date_valid_end: "{{ lookup('pipe','date -d \"now + 7 days\" +%Y-%m-%d:%H:%M:%S') }}" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify created schedule to all-day bigip_firewall_schedule: name: barfoo daily_hour_start: all-day days_of_week: - monday - tuesday provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify a schedule to have no end date bigip_firewall_schedule: name: foobar date_valid_start: "{{ lookup('pipe','date +%Y-%m-%d:%H:%M:%S') }}" date_valid_end: "indefinite" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove created schedule bigip_firewall_schedule: name: foobar state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| daily\_hour\_end string \| changed \| The time of day the rule will stop being used. Sample: 18:00 \| \| daily\_hour\_start string \| changed \| The time of day the rule will start to be in use. Sample: 13:00 \| \| date\_valid\_end string \| changed \| The end date/time schedule will apply to the rule. Sample: 2019-03-11:15:30:00 \| \| date\_valid\_start string \| changed \| The start date/time schedule will apply to the rule. Sample: 2019-03-01:15:30:00 \| \| days\_of\_week list / elements=string \| changed \| The days of the week the rule will be applied. Sample: ['monday', 'tuesday'] \| \| description string \| changed \| The user defined description text. Sample: Foo is bar \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_iapp_template – Manages TCL iApp templates on a BIG-IP. f5networks.f5\_modules.bigip\_iapp\_template – Manages TCL iApp templates on a BIG-IP. ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_iapp_template`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages TCL iApp templates on a BIG-IP. This module allows you to deploy iApp templates to the BIG-IP and manage their lifecycle. The conventional way to use this module is to import new iApps as needed, or by extracting the contents of the iApp archive that is provided at downloads.f5.com, and then importing all the iApps with this module. This module can also update existing iApps provided the source of the iApp changed while the name stayed the same. Note that this module will not reconfigure any services that may have been created using the `bigip_iapp_service` module. iApps are normally not updated in production. Instead, new versions are deployed and then existing services are changed to consume that new template. As such, the ability to update templates in-place requires using the `force` option. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| content string \| \| Sets the contents of an iApp template directly to the specified value. This is for simple values, but can be used with lookup plugins for anything complex or with formatting. `content` must be provided when creating new templates. \| \| force boolean \| Choices:* no * yes \| Specifies whether or not to force the uploading of an iApp. When `yes`, the system will force update the iApp even if there are iApp services using it. This will not update the running service, use `bigip_iapp_service` to do that. When `no`, the system updates the iApp only if there are no iApp services using the template. \| \| name string \| \| The name of the iApp template you want to delete. This option is only available when specifying a `state` of `absent` and is provided as a way to delete templates that you may no longer have the source of. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| Whether the iApp template should exist or not. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add the iApp contained in template iapp.tmpl bigip_iapp_template: content: "{{ lookup('template', 'iapp.tmpl') }}" state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Update a template in place bigip_iapp_template: content: "{{ lookup('template', 'iapp-new.tmpl') }}" state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Update a template in place that has existing services created from it. bigip_iapp_template: content: "{{ lookup('template', 'iapp-new.tmpl') }}" force: yes state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible F5Networks.F5_Modules F5Networks.F5\_Modules ====================== Collection version 1.12.0 Plugin Index ------------ These are the plugins in the f5networks.f5\_modules collection ### Lookup Plugins * [bigiq\_license](bigiq_license_lookup#ansible-collections-f5networks-f5-modules-bigiq-license-lookup) – Select a random license key from a pool of biqiq available licenses * [license\_hopper](license_hopper_lookup#ansible-collections-f5networks-f5-modules-license-hopper-lookup) – Return random license from list ### Modules * [bigip\_apm\_acl](bigip_apm_acl_module#ansible-collections-f5networks-f5-modules-bigip-apm-acl-module) – Manage user-defined APM ACLs * [bigip\_apm\_network\_access](bigip_apm_network_access_module#ansible-collections-f5networks-f5-modules-bigip-apm-network-access-module) – Manage APM Network Access resource * [bigip\_apm\_policy\_fetch](bigip_apm_policy_fetch_module#ansible-collections-f5networks-f5-modules-bigip-apm-policy-fetch-module) – Exports the APM policy or APM access profile from remote nodes. * [bigip\_apm\_policy\_import](bigip_apm_policy_import_module#ansible-collections-f5networks-f5-modules-bigip-apm-policy-import-module) – Manage BIG-IP APM policy or APM access profile imports * [bigip\_asm\_advanced\_settings](bigip_asm_advanced_settings_module#ansible-collections-f5networks-f5-modules-bigip-asm-advanced-settings-module) – Manage BIG-IP system ASM advanced settings * [bigip\_asm\_dos\_application](bigip_asm_dos_application_module#ansible-collections-f5networks-f5-modules-bigip-asm-dos-application-module) – Manage application settings for a DOS profile * [bigip\_asm\_policy\_fetch](bigip_asm_policy_fetch_module#ansible-collections-f5networks-f5-modules-bigip-asm-policy-fetch-module) – Exports the ASM policy from remote nodes. * [bigip\_asm\_policy\_import](bigip_asm_policy_import_module#ansible-collections-f5networks-f5-modules-bigip-asm-policy-import-module) – Manage BIG-IP ASM policy imports * [bigip\_asm\_policy\_manage](bigip_asm_policy_manage_module#ansible-collections-f5networks-f5-modules-bigip-asm-policy-manage-module) – Manage BIG-IP ASM policies * [bigip\_asm\_policy\_server\_technology](bigip_asm_policy_server_technology_module#ansible-collections-f5networks-f5-modules-bigip-asm-policy-server-technology-module) – Manages Server Technology on an ASM policy * [bigip\_asm\_policy\_signature\_set](bigip_asm_policy_signature_set_module#ansible-collections-f5networks-f5-modules-bigip-asm-policy-signature-set-module) – Manages Signature Sets on an ASM policy * [bigip\_cgnat\_lsn\_pool](bigip_cgnat_lsn_pool_module#ansible-collections-f5networks-f5-modules-bigip-cgnat-lsn-pool-module) – Manage CGNAT LSN Pools * [bigip\_cli\_alias](bigip_cli_alias_module#ansible-collections-f5networks-f5-modules-bigip-cli-alias-module) – Manage CLI aliases on a BIG-IP * [bigip\_cli\_script](bigip_cli_script_module#ansible-collections-f5networks-f5-modules-bigip-cli-script-module) – Manage CLI scripts on a BIG-IP * [bigip\_command](bigip_command_module#ansible-collections-f5networks-f5-modules-bigip-command-module) – Run TMSH and BASH commands on F5 devices * [bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) – Manage BIG-IP configuration sections * [bigip\_configsync\_action](bigip_configsync_action_module#ansible-collections-f5networks-f5-modules-bigip-configsync-action-module) – Perform different actions related to config-sync * [bigip\_data\_group](bigip_data_group_module#ansible-collections-f5networks-f5-modules-bigip-data-group-module) – Manage data groups on a BIG-IP * [bigip\_device\_auth](bigip_device_auth_module#ansible-collections-f5networks-f5-modules-bigip-device-auth-module) – Manage system authentication on a BIG-IP * [bigip\_device\_auth\_ldap](bigip_device_auth_ldap_module#ansible-collections-f5networks-f5-modules-bigip-device-auth-ldap-module) – Manage LDAP device authentication settings on BIG-IP * [bigip\_device\_auth\_radius](bigip_device_auth_radius_module#ansible-collections-f5networks-f5-modules-bigip-device-auth-radius-module) – Manages RADIUS auth configuration on a BIG-IP device * [bigip\_device\_auth\_radius\_server](bigip_device_auth_radius_server_module#ansible-collections-f5networks-f5-modules-bigip-device-auth-radius-server-module) – Manages the RADIUS server configuration of the device * [bigip\_device\_certificate](bigip_device_certificate_module#ansible-collections-f5networks-f5-modules-bigip-device-certificate-module) – Manage self-signed device certificates * [bigip\_device\_connectivity](bigip_device_connectivity_module#ansible-collections-f5networks-f5-modules-bigip-device-connectivity-module) – Manages device IP configuration settings for HA on a BIG-IP. * [bigip\_device\_dns](bigip_device_dns_module#ansible-collections-f5networks-f5-modules-bigip-device-dns-module) – Manage DNS settings on a BIG-IP * [bigip\_device\_group](bigip_device_group_module#ansible-collections-f5networks-f5-modules-bigip-device-group-module) – Manage device groups on a BIG-IP * [bigip\_device\_group\_member](bigip_device_group_member_module#ansible-collections-f5networks-f5-modules-bigip-device-group-member-module) – Manages members in a device group * [bigip\_device\_ha\_group](bigip_device_ha_group_module#ansible-collections-f5networks-f5-modules-bigip-device-ha-group-module) – Manage HA group settings on a BIG-IP system * [bigip\_device\_httpd](bigip_device_httpd_module#ansible-collections-f5networks-f5-modules-bigip-device-httpd-module) – Manage HTTPD related settings on a BIG-IP system * [bigip\_device\_info](bigip_device_info_module#ansible-collections-f5networks-f5-modules-bigip-device-info-module) – Collect information from F5 BIG-IP devices * [bigip\_device\_license](bigip_device_license_module#ansible-collections-f5networks-f5-modules-bigip-device-license-module) – Manage license installation and activation on BIG-IP devices * [bigip\_device\_ntp](bigip_device_ntp_module#ansible-collections-f5networks-f5-modules-bigip-device-ntp-module) – Manage NTP servers on a BIG-IP * [bigip\_device\_sshd](bigip_device_sshd_module#ansible-collections-f5networks-f5-modules-bigip-device-sshd-module) – Manage the SSHD settings of a BIG-IP * [bigip\_device\_syslog](bigip_device_syslog_module#ansible-collections-f5networks-f5-modules-bigip-device-syslog-module) – Manage system-level syslog settings on BIG-IP * [bigip\_device\_traffic\_group](bigip_device_traffic_group_module#ansible-collections-f5networks-f5-modules-bigip-device-traffic-group-module) – Manages traffic groups on BIG-IP * [bigip\_device\_trust](bigip_device_trust_module#ansible-collections-f5networks-f5-modules-bigip-device-trust-module) – Manage the trust relationships between BIG-IPs * [bigip\_dns\_cache\_resolver](bigip_dns_cache_resolver_module#ansible-collections-f5networks-f5-modules-bigip-dns-cache-resolver-module) – Manage DNS resolver cache configuration on a BIG-IP * [bigip\_dns\_nameserver](bigip_dns_nameserver_module#ansible-collections-f5networks-f5-modules-bigip-dns-nameserver-module) – Manage LTM DNS nameservers on a BIG-IP * [bigip\_dns\_resolver](bigip_dns_resolver_module#ansible-collections-f5networks-f5-modules-bigip-dns-resolver-module) – Manage DNS resolvers on a BIG-IP * [bigip\_dns\_zone](bigip_dns_zone_module#ansible-collections-f5networks-f5-modules-bigip-dns-zone-module) – Manage DNS zones on BIG-IP * [bigip\_file\_copy](bigip_file_copy_module#ansible-collections-f5networks-f5-modules-bigip-file-copy-module) – Manage files in datastores on a BIG-IP * [bigip\_firewall\_address\_list](bigip_firewall_address_list_module#ansible-collections-f5networks-f5-modules-bigip-firewall-address-list-module) – Manage address lists on BIG-IP AFM * [bigip\_firewall\_dos\_profile](bigip_firewall_dos_profile_module#ansible-collections-f5networks-f5-modules-bigip-firewall-dos-profile-module) – Manage AFM DoS profiles on a BIG-IP * [bigip\_firewall\_dos\_vector](bigip_firewall_dos_vector_module#ansible-collections-f5networks-f5-modules-bigip-firewall-dos-vector-module) – Manage attack vector configuration in an AFM DoS profile * [bigip\_firewall\_global\_rules](bigip_firewall_global_rules_module#ansible-collections-f5networks-f5-modules-bigip-firewall-global-rules-module) – Manage AFM global rule settings on BIG-IP * [bigip\_firewall\_log\_profile](bigip_firewall_log_profile_module#ansible-collections-f5networks-f5-modules-bigip-firewall-log-profile-module) – Manages AFM logging profiles configured in the system * [bigip\_firewall\_log\_profile\_network](bigip_firewall_log_profile_network_module#ansible-collections-f5networks-f5-modules-bigip-firewall-log-profile-network-module) – Configures Network Firewall related settings of the log profile * [bigip\_firewall\_policy](bigip_firewall_policy_module#ansible-collections-f5networks-f5-modules-bigip-firewall-policy-module) – Manage AFM security firewall policies on a BIG-IP * [bigip\_firewall\_port\_list](bigip_firewall_port_list_module#ansible-collections-f5networks-f5-modules-bigip-firewall-port-list-module) – Manage port lists on BIG-IP AFM * [bigip\_firewall\_rule](bigip_firewall_rule_module#ansible-collections-f5networks-f5-modules-bigip-firewall-rule-module) – Manage AFM Firewall rules * [bigip\_firewall\_rule\_list](bigip_firewall_rule_list_module#ansible-collections-f5networks-f5-modules-bigip-firewall-rule-list-module) – Manage AFM security firewall policies on a BIG-IP * [bigip\_firewall\_schedule](bigip_firewall_schedule_module#ansible-collections-f5networks-f5-modules-bigip-firewall-schedule-module) – Manage BIG-IP AFM schedule configurations * [bigip\_gtm\_datacenter](bigip_gtm_datacenter_module#ansible-collections-f5networks-f5-modules-bigip-gtm-datacenter-module) – Manage Datacenter configuration in BIG-IP * [bigip\_gtm\_dns\_listener](bigip_gtm_dns_listener_module#ansible-collections-f5networks-f5-modules-bigip-gtm-dns-listener-module) – Configures the BIG-IP DNS system to answer TCP or UDP DNS requests * [bigip\_gtm\_global](bigip_gtm_global_module#ansible-collections-f5networks-f5-modules-bigip-gtm-global-module) – Manages global GTM settings * [bigip\_gtm\_monitor\_bigip](bigip_gtm_monitor_bigip_module#ansible-collections-f5networks-f5-modules-bigip-gtm-monitor-bigip-module) – Manages F5 BIG-IP GTM BIG-IP monitors * [bigip\_gtm\_monitor\_external](bigip_gtm_monitor_external_module#ansible-collections-f5networks-f5-modules-bigip-gtm-monitor-external-module) – Manages external GTM monitors on a BIG-IP * [bigip\_gtm\_monitor\_firepass](bigip_gtm_monitor_firepass_module#ansible-collections-f5networks-f5-modules-bigip-gtm-monitor-firepass-module) – Manages F5 BIG-IP GTM FirePass monitors * [bigip\_gtm\_monitor\_http](bigip_gtm_monitor_http_module#ansible-collections-f5networks-f5-modules-bigip-gtm-monitor-http-module) – Manages F5 BIG-IP GTM HTTP monitors * [bigip\_gtm\_monitor\_https](bigip_gtm_monitor_https_module#ansible-collections-f5networks-f5-modules-bigip-gtm-monitor-https-module) – Manages F5 BIG-IP GTM HTTPS monitors * [bigip\_gtm\_monitor\_tcp](bigip_gtm_monitor_tcp_module#ansible-collections-f5networks-f5-modules-bigip-gtm-monitor-tcp-module) – Manages F5 BIG-IP GTM TCP monitors * [bigip\_gtm\_monitor\_tcp\_half\_open](bigip_gtm_monitor_tcp_half_open_module#ansible-collections-f5networks-f5-modules-bigip-gtm-monitor-tcp-half-open-module) – Manages F5 BIG-IP GTM TCP half-open monitors * [bigip\_gtm\_pool](bigip_gtm_pool_module#ansible-collections-f5networks-f5-modules-bigip-gtm-pool-module) – Manages F5 BIG-IP GTM pools * [bigip\_gtm\_pool\_member](bigip_gtm_pool_member_module#ansible-collections-f5networks-f5-modules-bigip-gtm-pool-member-module) – Manage GTM pool member settings * [bigip\_gtm\_server](bigip_gtm_server_module#ansible-collections-f5networks-f5-modules-bigip-gtm-server-module) – Manages F5 BIG-IP GTM servers * [bigip\_gtm\_topology\_record](bigip_gtm_topology_record_module#ansible-collections-f5networks-f5-modules-bigip-gtm-topology-record-module) – Manages GTM Topology Records * [bigip\_gtm\_topology\_region](bigip_gtm_topology_region_module#ansible-collections-f5networks-f5-modules-bigip-gtm-topology-region-module) – Manages GTM Topology Regions * [bigip\_gtm\_virtual\_server](bigip_gtm_virtual_server_module#ansible-collections-f5networks-f5-modules-bigip-gtm-virtual-server-module) – Manages F5 BIG-IP GTM virtual servers * [bigip\_gtm\_wide\_ip](bigip_gtm_wide_ip_module#ansible-collections-f5networks-f5-modules-bigip-gtm-wide-ip-module) – Manages F5 BIG-IP GTM Wide IP * [bigip\_hostname](bigip_hostname_module#ansible-collections-f5networks-f5-modules-bigip-hostname-module) – Manage the hostname of a BIG-IP * [bigip\_iapp\_service](bigip_iapp_service_module#ansible-collections-f5networks-f5-modules-bigip-iapp-service-module) – Manages TCL iApp services on a BIG-IP * [bigip\_iapp\_template](bigip_iapp_template_module#ansible-collections-f5networks-f5-modules-bigip-iapp-template-module) – Manages TCL iApp templates on a BIG-IP. * [bigip\_ike\_peer](bigip_ike_peer_module#ansible-collections-f5networks-f5-modules-bigip-ike-peer-module) – Manage IPSec IKE Peer configuration on BIG-IP * [bigip\_imish\_config](bigip_imish_config_module#ansible-collections-f5networks-f5-modules-bigip-imish-config-module) – Manage BIG-IP advanced routing configuration sections * [bigip\_interface](bigip_interface_module#ansible-collections-f5networks-f5-modules-bigip-interface-module) – Module to manage BIG-IP physical interfaces. * [bigip\_ipsec\_policy](bigip_ipsec_policy_module#ansible-collections-f5networks-f5-modules-bigip-ipsec-policy-module) – Manage IPSec policies on a BIG-IP * [bigip\_irule](bigip_irule_module#ansible-collections-f5networks-f5-modules-bigip-irule-module) – Manage iRules across different modules on a BIG-IP * [bigip\_log\_destination](bigip_log_destination_module#ansible-collections-f5networks-f5-modules-bigip-log-destination-module) – Manages log destinations on a BIG-IP. * [bigip\_log\_publisher](bigip_log_publisher_module#ansible-collections-f5networks-f5-modules-bigip-log-publisher-module) – Manages log publishers on a BIG-IP * [bigip\_lx\_package](bigip_lx_package_module#ansible-collections-f5networks-f5-modules-bigip-lx-package-module) – Manages Javascript LX packages on a BIG-IP * [bigip\_management\_route](bigip_management_route_module#ansible-collections-f5networks-f5-modules-bigip-management-route-module) – Manage system management routes on a BIG-IP * [bigip\_message\_routing\_peer](bigip_message_routing_peer_module#ansible-collections-f5networks-f5-modules-bigip-message-routing-peer-module) – Manage peers for routing generic message protocol messages * [bigip\_message\_routing\_protocol](bigip_message_routing_protocol_module#ansible-collections-f5networks-f5-modules-bigip-message-routing-protocol-module) – Manage the generic message parser profile. * [bigip\_message\_routing\_route](bigip_message_routing_route_module#ansible-collections-f5networks-f5-modules-bigip-message-routing-route-module) – Manages static routes for routing message protocol messages * [bigip\_message\_routing\_router](bigip_message_routing_router_module#ansible-collections-f5networks-f5-modules-bigip-message-routing-router-module) – Manages router profiles for message-routing protocols * [bigip\_message\_routing\_transport\_config](bigip_message_routing_transport_config_module#ansible-collections-f5networks-f5-modules-bigip-message-routing-transport-config-module) – Manages configuration for an outgoing connection * [bigip\_monitor\_dns](bigip_monitor_dns_module#ansible-collections-f5networks-f5-modules-bigip-monitor-dns-module) – Manage DNS monitors on a BIG-IP * [bigip\_monitor\_external](bigip_monitor_external_module#ansible-collections-f5networks-f5-modules-bigip-monitor-external-module) – Manages external LTM monitors on a BIG-IP * [bigip\_monitor\_ftp](bigip_monitor_ftp_module#ansible-collections-f5networks-f5-modules-bigip-monitor-ftp-module) – Manage FTP monitors on a BIG-IP * [bigip\_monitor\_gateway\_icmp](bigip_monitor_gateway_icmp_module#ansible-collections-f5networks-f5-modules-bigip-monitor-gateway-icmp-module) – Manages F5 BIG-IP LTM gateway ICMP monitors * [bigip\_monitor\_http](bigip_monitor_http_module#ansible-collections-f5networks-f5-modules-bigip-monitor-http-module) – Manages F5 BIG-IP LTM HTTP monitors * [bigip\_monitor\_https](bigip_monitor_https_module#ansible-collections-f5networks-f5-modules-bigip-monitor-https-module) – Manages F5 BIG-IP LTM HTTPS monitors * [bigip\_monitor\_icmp](bigip_monitor_icmp_module#ansible-collections-f5networks-f5-modules-bigip-monitor-icmp-module) – Manages F5 BIG-IP LTM ICMP monitors * [bigip\_monitor\_ldap](bigip_monitor_ldap_module#ansible-collections-f5networks-f5-modules-bigip-monitor-ldap-module) – Manages BIG-IP LDAP monitors * [bigip\_monitor\_mysql](bigip_monitor_mysql_module#ansible-collections-f5networks-f5-modules-bigip-monitor-mysql-module) – Manages BIG-IP MySQL monitors * [bigip\_monitor\_oracle](bigip_monitor_oracle_module#ansible-collections-f5networks-f5-modules-bigip-monitor-oracle-module) – Manages BIG-IP Oracle monitors * [bigip\_monitor\_smtp](bigip_monitor_smtp_module#ansible-collections-f5networks-f5-modules-bigip-monitor-smtp-module) – Manage SMTP monitors on a BIG-IP * [bigip\_monitor\_snmp\_dca](bigip_monitor_snmp_dca_module#ansible-collections-f5networks-f5-modules-bigip-monitor-snmp-dca-module) – Manages BIG-IP SNMP data collecting agent (DCA) monitors * [bigip\_monitor\_tcp](bigip_monitor_tcp_module#ansible-collections-f5networks-f5-modules-bigip-monitor-tcp-module) – Manages F5 BIG-IP LTM TCP monitors * [bigip\_monitor\_tcp\_echo](bigip_monitor_tcp_echo_module#ansible-collections-f5networks-f5-modules-bigip-monitor-tcp-echo-module) – Manages F5 BIG-IP LTM TCP echo monitors * [bigip\_monitor\_tcp\_half\_open](bigip_monitor_tcp_half_open_module#ansible-collections-f5networks-f5-modules-bigip-monitor-tcp-half-open-module) – Manages F5 BIG-IP LTM TCP half-open monitors * [bigip\_monitor\_udp](bigip_monitor_udp_module#ansible-collections-f5networks-f5-modules-bigip-monitor-udp-module) – Manages F5 BIG-IP LTM UDP monitors * [bigip\_network\_globals](bigip_network_globals_module#ansible-collections-f5networks-f5-modules-bigip-network-globals-module) – Manage network global settings on BIG-IP * [bigip\_node](bigip_node_module#ansible-collections-f5networks-f5-modules-bigip-node-module) – Manages F5 BIG-IP LTM nodes * [bigip\_partition](bigip_partition_module#ansible-collections-f5networks-f5-modules-bigip-partition-module) – Manage BIG-IP partitions * [bigip\_password\_policy](bigip_password_policy_module#ansible-collections-f5networks-f5-modules-bigip-password-policy-module) – Manages the authentication password policy on a BIG-IP * [bigip\_policy](bigip_policy_module#ansible-collections-f5networks-f5-modules-bigip-policy-module) – Manage general policy configuration on a BIG-IP * [bigip\_policy\_rule](bigip_policy_rule_module#ansible-collections-f5networks-f5-modules-bigip-policy-rule-module) – Manage LTM policy rules on a BIG-IP * [bigip\_pool](bigip_pool_module#ansible-collections-f5networks-f5-modules-bigip-pool-module) – Manages F5 BIG-IP LTM pools * [bigip\_pool\_member](bigip_pool_member_module#ansible-collections-f5networks-f5-modules-bigip-pool-member-module) – Manages F5 BIG-IP LTM pool members * [bigip\_profile\_analytics](bigip_profile_analytics_module#ansible-collections-f5networks-f5-modules-bigip-profile-analytics-module) – Manage HTTP analytics profiles on a BIG-IP * [bigip\_profile\_client\_ssl](bigip_profile_client_ssl_module#ansible-collections-f5networks-f5-modules-bigip-profile-client-ssl-module) – Manages client SSL profiles on a BIG-IP * [bigip\_profile\_dns](bigip_profile_dns_module#ansible-collections-f5networks-f5-modules-bigip-profile-dns-module) – Manage DNS profiles on a BIG-IP * [bigip\_profile\_fastl4](bigip_profile_fastl4_module#ansible-collections-f5networks-f5-modules-bigip-profile-fastl4-module) – Manages Fast L4 profiles * [bigip\_profile\_ftp](bigip_profile_ftp_module#ansible-collections-f5networks-f5-modules-bigip-profile-ftp-module) – Manages FTP profiles * [bigip\_profile\_http](bigip_profile_http_module#ansible-collections-f5networks-f5-modules-bigip-profile-http-module) – Manage HTTP profiles on a BIG-IP * [bigip\_profile\_http2](bigip_profile_http2_module#ansible-collections-f5networks-f5-modules-bigip-profile-http2-module) – Manage HTTP2 profiles on a BIG-IP * [bigip\_profile\_http\_compression](bigip_profile_http_compression_module#ansible-collections-f5networks-f5-modules-bigip-profile-http-compression-module) – Manage HTTP compression profiles on a BIG-IP * [bigip\_profile\_oneconnect](bigip_profile_oneconnect_module#ansible-collections-f5networks-f5-modules-bigip-profile-oneconnect-module) – Manage OneConnect profiles on a BIG-IP * [bigip\_profile\_persistence\_cookie](bigip_profile_persistence_cookie_module#ansible-collections-f5networks-f5-modules-bigip-profile-persistence-cookie-module) – Manage cookie persistence profiles on BIG-IP * [bigip\_profile\_persistence\_src\_addr](bigip_profile_persistence_src_addr_module#ansible-collections-f5networks-f5-modules-bigip-profile-persistence-src-addr-module) – Manage source address persistence profiles * [bigip\_profile\_persistence\_universal](bigip_profile_persistence_universal_module#ansible-collections-f5networks-f5-modules-bigip-profile-persistence-universal-module) – Manage universal persistence profiles * [bigip\_profile\_server\_ssl](bigip_profile_server_ssl_module#ansible-collections-f5networks-f5-modules-bigip-profile-server-ssl-module) – Manages server SSL profiles on a BIG-IP * [bigip\_profile\_sip](bigip_profile_sip_module#ansible-collections-f5networks-f5-modules-bigip-profile-sip-module) – Manage SIP profiles on a BIG-IP * [bigip\_profile\_tcp](bigip_profile_tcp_module#ansible-collections-f5networks-f5-modules-bigip-profile-tcp-module) – Manage TCP profiles on a BIG-IP * [bigip\_profile\_udp](bigip_profile_udp_module#ansible-collections-f5networks-f5-modules-bigip-profile-udp-module) – Manage UDP profiles on a BIG-IP * [bigip\_provision](bigip_provision_module#ansible-collections-f5networks-f5-modules-bigip-provision-module) – Manage BIG-IP module provisioning * [bigip\_qkview](bigip_qkview_module#ansible-collections-f5networks-f5-modules-bigip-qkview-module) – Manage QKviews on the device * [bigip\_remote\_role](bigip_remote_role_module#ansible-collections-f5networks-f5-modules-bigip-remote-role-module) – Manage remote roles on a BIG-IP * [bigip\_remote\_syslog](bigip_remote_syslog_module#ansible-collections-f5networks-f5-modules-bigip-remote-syslog-module) – Manipulate remote syslog settings on a BIG-IP * [bigip\_remote\_user](bigip_remote_user_module#ansible-collections-f5networks-f5-modules-bigip-remote-user-module) – Manages default settings for remote user accounts on a BIG-IP * [bigip\_routedomain](bigip_routedomain_module#ansible-collections-f5networks-f5-modules-bigip-routedomain-module) – Manage route domains on a BIG-IP * [bigip\_selfip](bigip_selfip_module#ansible-collections-f5networks-f5-modules-bigip-selfip-module) – Manage Self-IPs on a BIG-IP system * [bigip\_service\_policy](bigip_service_policy_module#ansible-collections-f5networks-f5-modules-bigip-service-policy-module) – Manages service policies on a BIG-IP. * [bigip\_smtp](bigip_smtp_module#ansible-collections-f5networks-f5-modules-bigip-smtp-module) – Manages SMTP settings on the BIG-IP * [bigip\_snat\_pool](bigip_snat_pool_module#ansible-collections-f5networks-f5-modules-bigip-snat-pool-module) – Manage SNAT pools on a BIG-IP * [bigip\_snat\_translation](bigip_snat_translation_module#ansible-collections-f5networks-f5-modules-bigip-snat-translation-module) – Manage SNAT translations on a BIG-IP * [bigip\_snmp](bigip_snmp_module#ansible-collections-f5networks-f5-modules-bigip-snmp-module) – Manipulate general SNMP settings on a BIG-IP * [bigip\_snmp\_community](bigip_snmp_community_module#ansible-collections-f5networks-f5-modules-bigip-snmp-community-module) – Manages SNMP communities on a BIG-IP. * [bigip\_snmp\_trap](bigip_snmp_trap_module#ansible-collections-f5networks-f5-modules-bigip-snmp-trap-module) – Manipulate SNMP trap information on a BIG-IP * [bigip\_software\_image](bigip_software_image_module#ansible-collections-f5networks-f5-modules-bigip-software-image-module) – Manage software images on a BIG-IP * [bigip\_software\_install](bigip_software_install_module#ansible-collections-f5networks-f5-modules-bigip-software-install-module) – Install software images on a BIG-IP * [bigip\_software\_update](bigip_software_update_module#ansible-collections-f5networks-f5-modules-bigip-software-update-module) – Manage the software update settings of a BIG-IP * [bigip\_ssl\_certificate](bigip_ssl_certificate_module#ansible-collections-f5networks-f5-modules-bigip-ssl-certificate-module) – Import/Delete certificates from BIG-IP * [bigip\_ssl\_csr](bigip_ssl_csr_module#ansible-collections-f5networks-f5-modules-bigip-ssl-csr-module) – Create SSL CSR files on the BIG-IP * [bigip\_ssl\_key](bigip_ssl_key_module#ansible-collections-f5networks-f5-modules-bigip-ssl-key-module) – Import/Delete SSL keys from BIG-IP * [bigip\_ssl\_key\_cert](bigip_ssl_key_cert_module#ansible-collections-f5networks-f5-modules-bigip-ssl-key-cert-module) – Import/Delete SSL keys and certs from BIG-IP * [bigip\_ssl\_ocsp](bigip_ssl_ocsp_module#ansible-collections-f5networks-f5-modules-bigip-ssl-ocsp-module) – Manage OCSP configurations on BIG-IP * [bigip\_static\_route](bigip_static_route_module#ansible-collections-f5networks-f5-modules-bigip-static-route-module) – Manipulate static routes on a BIG-IP * [bigip\_sys\_daemon\_log\_tmm](bigip_sys_daemon_log_tmm_module#ansible-collections-f5networks-f5-modules-bigip-sys-daemon-log-tmm-module) – Manage BIG-IP tmm daemon log settings * [bigip\_sys\_db](bigip_sys_db_module#ansible-collections-f5networks-f5-modules-bigip-sys-db-module) – Manage BIG-IP system database variables * [bigip\_sys\_global](bigip_sys_global_module#ansible-collections-f5networks-f5-modules-bigip-sys-global-module) – Manage BIG-IP global settings * [bigip\_timer\_policy](bigip_timer_policy_module#ansible-collections-f5networks-f5-modules-bigip-timer-policy-module) – Manage timer policies on a BIG-IP * [bigip\_traffic\_selector](bigip_traffic_selector_module#ansible-collections-f5networks-f5-modules-bigip-traffic-selector-module) – Manage IPSec Traffic Selectors on BIG-IP * [bigip\_trunk](bigip_trunk_module#ansible-collections-f5networks-f5-modules-bigip-trunk-module) – Manage trunks on a BIG-IP * [bigip\_tunnel](bigip_tunnel_module#ansible-collections-f5networks-f5-modules-bigip-tunnel-module) – Manage tunnels on a BIG-IP * [bigip\_ucs](bigip_ucs_module#ansible-collections-f5networks-f5-modules-bigip-ucs-module) – Manage upload, installation, and removal of UCS files * [bigip\_ucs\_fetch](bigip_ucs_fetch_module#ansible-collections-f5networks-f5-modules-bigip-ucs-fetch-module) – Fetches a UCS file from remote nodes * [bigip\_user](bigip_user_module#ansible-collections-f5networks-f5-modules-bigip-user-module) – Manage user accounts and user attributes on a BIG-IP * [bigip\_vcmp\_guest](bigip_vcmp_guest_module#ansible-collections-f5networks-f5-modules-bigip-vcmp-guest-module) – Manages vCMP guests on a BIG-IP * [bigip\_virtual\_address](bigip_virtual_address_module#ansible-collections-f5networks-f5-modules-bigip-virtual-address-module) – Manage LTM virtual addresses on a BIG-IP * [bigip\_virtual\_server](bigip_virtual_server_module#ansible-collections-f5networks-f5-modules-bigip-virtual-server-module) – Manage LTM virtual servers on a BIG-IP * [bigip\_vlan](bigip_vlan_module#ansible-collections-f5networks-f5-modules-bigip-vlan-module) – Manage VLANs on a BIG-IP system * [bigip\_wait](bigip_wait_module#ansible-collections-f5networks-f5-modules-bigip-wait-module) – Wait for a BIG-IP condition before continuing * [bigiq\_application\_fasthttp](bigiq_application_fasthttp_module#ansible-collections-f5networks-f5-modules-bigiq-application-fasthttp-module) – Manages BIG-IQ FastHTTP applications * [bigiq\_application\_fastl4\_tcp](bigiq_application_fastl4_tcp_module#ansible-collections-f5networks-f5-modules-bigiq-application-fastl4-tcp-module) – Manages BIG-IQ FastL4 TCP applications * [bigiq\_application\_fastl4\_udp](bigiq_application_fastl4_udp_module#ansible-collections-f5networks-f5-modules-bigiq-application-fastl4-udp-module) – Manages BIG-IQ FastL4 UDP applications * [bigiq\_application\_http](bigiq_application_http_module#ansible-collections-f5networks-f5-modules-bigiq-application-http-module) – Manages BIG-IQ HTTP applications * [bigiq\_application\_https\_offload](bigiq_application_https_offload_module#ansible-collections-f5networks-f5-modules-bigiq-application-https-offload-module) – Manages BIG-IQ HTTPS offload applications * [bigiq\_application\_https\_waf](bigiq_application_https_waf_module#ansible-collections-f5networks-f5-modules-bigiq-application-https-waf-module) – Manages BIG-IQ HTTPS WAF applications * [bigiq\_device\_discovery](bigiq_device_discovery_module#ansible-collections-f5networks-f5-modules-bigiq-device-discovery-module) – Manage BIG-IP devices through BIG-IQ * [bigiq\_device\_info](bigiq_device_info_module#ansible-collections-f5networks-f5-modules-bigiq-device-info-module) – Collect information from F5 BIG-IQ devices * [bigiq\_regkey\_license](bigiq_regkey_license_module#ansible-collections-f5networks-f5-modules-bigiq-regkey-license-module) – Manages licenses in a BIG-IQ registration key pool * [bigiq\_regkey\_license\_assignment](bigiq_regkey_license_assignment_module#ansible-collections-f5networks-f5-modules-bigiq-regkey-license-assignment-module) – Manage regkey license assignment on BIG-IPs from a BIG-IQ * [bigiq\_regkey\_pool](bigiq_regkey_pool_module#ansible-collections-f5networks-f5-modules-bigiq-regkey-pool-module) – Manages registration key pools on BIG-IQ * [bigiq\_utility\_license](bigiq_utility_license_module#ansible-collections-f5networks-f5-modules-bigiq-utility-license-module) – Manage utility licenses on a BIG-IQ * [bigiq\_utility\_license\_assignment](bigiq_utility_license_assignment_module#ansible-collections-f5networks-f5-modules-bigiq-utility-license-assignment-module) – Manage utility license assignment on BIG-IPs from a BIG-IQ See also List of [collections](../../index#list-of-collections) with docs hosted here.	programming_docs
ansible f5networks.f5_modules.bigip_imish_config – Manage BIG-IP advanced routing configuration sections f5networks.f5\_modules.bigip\_imish\_config – Manage BIG-IP advanced routing configuration sections =================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_imish_config`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module provides an implementation for working with advanced routing configuration sections in a deterministic way. Note This module has a corresponding [action plugin](../../../plugins/action#action-plugins). Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| after list / elements=string \| \| The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before, this allows the playbook designer to append a set of commands to be executed after the command set. \| \| allow\_duplicates boolean added in 1.2.0 of f5networks.f5\_modules \| Choices:* no ← * yes \| Allows duplicate commands to be sent to the device. This is to accommodate scenarios where address families are configured. Only used with the `lines` parameter. \| \| backup boolean \| Choices:* no ← * yes \| This argument will cause the module to create a full backup of the current `running-config` from the remote device before any changes are made. The backup file is written to the `backup` folder in the playbook root directory or role root directory, if playbook is part of an Ansible role. If the directory does not exist, it is created. \| \| backup\_options dictionary \| \| This is a dict object containing configurable options related to backup file path. The value of this option is read-only when `backup` is set to yes. If `backup` is set to no, this option will be silently ignored. \| \| \| dir\_path path \| \| This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist, it will be first created and the filename is either the value of `filename` or default filename as described in `filename` options description. If the path value is not given, a backup directory will be created in the current working directory and backup configuration will be copied in `filename` within the backup directory. \| \| \| filename string \| \| The filename to be used to store the backup configuration. If the filename is not given, it will be generated based on the hostname, current time and date in the format defined by <hostname>\_config.<current-date>@<current-time> \| \| before list / elements=string \| \| The ordered set of commands to push onto the command stack if a change needs to be made. This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes, without affecting how the set of commands are matched against the system. \| \| diff\_against string \| Choices:* startup ← * intended * running \| When using the `ansible-playbook --diff` command line argument, the module can generate diffs against different sources. When this option is configured as startup, the module will return the diff of the running-config against the startup-config. When this option is configured as intended, the module will return the diff of the running-config against the configuration provided in the `intended_config` argument. When this option is configured as running, the module will return the before and after diff of the running-config with respect to any changes made to the device configuration. \| \| diff\_ignore\_lines list / elements=string \| \| Use this argument to specify one or more lines that should be ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches. \| \| intended\_config string \| \| The `intended_config` provides the master configuration the node should conform to and is used to check the final running-config against. This argument will not modify any settings on the remote device and is strictly used to check the compliance of the current device's configuration against. When specifying this argument, the task should also modify the `diff_against` value and set it to intended. \| \| lines list / elements=string \| \| The ordered set of commands that should be configured in the section. The commands must be the exact same as those found in the device running-config. Be sure to note the configuration command syntax, as some commands are automatically modified by the device config parser. aliases: commands \| \| match string \| Choices:* line ← * strict * exact * none \| Instructs the module on the way to perform the matching of the set of commands against the current device config. If match is set to line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device. \| \| parents list / elements=string \| \| The ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against. If the `parents` argument is omitted, the commands are checked against the set of top level or global commands. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| replace string \| Choices:* line ← * block \| Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line, the modified lines are pushed to the device in configuration mode. If the replace argument is set to block, the entire command block is pushed to the device in configuration mode if any line is not correct. \| \| route\_domain string \| Default:0 \| Route domain on which to manage the BGP configuration. \| \| running\_config string \| \| By default, the module will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when you do not want to have the task get the current running-config for every task in a playbook. The running\_config argument allows the implementer to pass in the configuration to use as the base config for comparison. aliases: config \| \| save\_when string \| Choices:* always * never ← * modified * changed \| When changes are made to the device running-configuration, the changes are not copied to non-volatile storage by default. If the argument is set to always, the running-config will always be copied to the startup-config and the modified flag will always be set to `True`. If the argument is set to modified, the running-config will only be copied to the startup-config if it has changed since the last save to startup-config. If the argument is set to never, the running-config will never be copied to the startup-config. If the argument is set to changed, the running-config will only be copied to the startup-config if the task has made a change. \| \| src path \| \| The src argument provides a path to the configuration file to load into the remote system. The path can either be a full system path to the configuration file if the value starts with /, or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the lines and parents arguments. \| Notes ----- Note * Abbreviated commands are NOT idempotent * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: configure top level configuration and save it bigip_imish_config: lines: bfd slow-timer 2000 save_when: modified provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: diff the running-config against a provided config bigip_imish_config: diff_against: intended intended_config: "{{ lookup('file', 'master.cfg') }}" provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add config to a parent block bigip_imish_config: lines: - bgp graceful-restart restart-time 120 - redistribute kernel route-map rhi - neighbor 10.10.10.11 remote-as 65000 - neighbor 10.10.10.11 fall-over bfd - neighbor 10.10.10.11 remote-as 65000 - neighbor 10.10.10.11 fall-over bfd parents: router bgp 64664 match: exact provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove an existing acl before writing it bigip_imish_config: lines: - access-list 10 permit 20.20.20.20 - access-list 10 permit 20.20.20.21 - access-list 10 deny any before: no access-list 10 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: for idempotency, use full-form commands bigip_imish_config: lines: # - desc My interface - description My Interface # parents: int ANYCAST-P2P-2 parents: interface ANYCAST-P2P-2 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: configurable backup path bigip_imish_config: lines: bfd slow-timer 2000 backup: yes provider: user: admin password: secret server: lb.mydomain.com backup_options: filename: backup.cfg dir_path: /home/user delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| backup\_path string \| when backup is yes \| The full path to the backup file. Sample: /playbooks/ansible/backup/bigip\_imish\_config.2016-07-16@22:28:34 \| \| commands list / elements=string \| always \| The set of commands that will be pushed to the remote device. Sample: ['interface ANYCAST-P2P-2', 'neighbor 20.20.20.21 remote-as 65000', 'neighbor 20.20.20.21 fall-over bfd'] \| \| updates list / elements=string \| always \| The set of commands that will be pushed to the remote device. Sample: ['interface ANYCAST-P2P-2', 'neighbor 20.20.20.21 remote-as 65000', 'neighbor 20.20.20.21 fall-over bfd'] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_ssl_certificate – Import/Delete certificates from BIG-IP f5networks.f5\_modules.bigip\_ssl\_certificate – Import/Delete certificates from BIG-IP ======================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ssl_certificate`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module imports/deletes SSL certificates on BIG-IP LTM. Certificates can be imported from certificate and key files on the local disk, in PEM format. Requirements ------------ The below requirements are needed on the host that executes this module. * BIG-IP >= v12 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| content string \| \| Sets the contents of a certificate directly to the specified value. This is used with lookup plugins or for anything with formatting, or `content` must be provided when `state` is `present`. aliases: cert\_content \| \| issuer\_cert string \| \| Issuer certificate used for OCSP monitoring. This parameter is only valid on versions of BIG-IP 13.0.0 or above. \| \| name string / required \| \| SSL Certificate Name. This is the cert name used when importing a certificate into the BIG-IP. It also determines the filenames of the objects on the LTM. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| Certificate state. This determines if the provided certificate and key is to be made `present` on the device or `absent`. \| Notes ----- Note * This module does not behave like other modules that you might include in roles, where referencing files or templates first looks in the role’s files or templates directory. To have it behave that way, use the Ansible file or template lookup (see Examples). The lookups behave as expected in a role context. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Use a file lookup to import PEM Certificate bigip_ssl_certificate: name: certificate-name state: present content: "{{ lookup('file', '/path/to/cert.crt') }}" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Use a file lookup to import CA certificate chain bigip_ssl_certificate: name: ca-chain-name state: present content: "{{ lookup('file', '/path/to/ca-chain.crt') }}" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Delete Certificate bigip_ssl_certificate: name: certificate-name state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cert\_name string \| created \| The name of the certificate. Sample: cert1 \| \| checksum string \| changed and created \| SHA1 checksum of the cert. Sample: f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0 \| \| filename string \| created \| The name of the SSL certificate. Sample: cert1.crt \| \| source\_path string \| created \| Path on BIG-IP where the source of the certificate is stored. Sample: /var/config/rest/downloads/cert1.crt \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_device_certificate – Manage self-signed device certificates f5networks.f5\_modules.bigip\_device\_certificate – Manage self-signed device certificates ========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_certificate`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Module used to create and/or renew self-signed device certificates for BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| add\_to\_trusted boolean \| Choices:* no ← * yes \| Specified if the certificate should be added to the trusted client and server certificate files. \| \| cert\_name string \| Default:"server.crt" \| Specifies the full name of the certificate file. If the name is not default `server.crt`, the module will configure `httpd` to use them prior to restarting the `httpd` daemon. \| \| days\_valid integer / required \| \| Specifies the interval for which the self-signed certificate is valid. The maximum value is 25 years: `9125` days \| \| force boolean \| Choices:* no ← * yes \| When `yes`, will update or overwrite the existing certificate when it is not expired on the device. When `no`, the certificate will only be updated/overwritten if expired. Generally should be `yes` only in cases where you need to update certificate that is about to expire. This option is also needed when generating a new certificate to replace non-expired one. \| \| issuer dictionary \| \| Certificate properties, required when generating new certificates. \| \| \| common\_name string \| \| Specifies the Common Name attribute for the certificate. \| \| \| country string \| \| Specifies the Country name attribute for the certificate. \| \| \| division string \| \| Specifies the department name attribute for the certificate. \| \| \| email string \| \| Specifies the email address of the domain administrator. \| \| \| locality string \| \| Specifies the city or town name for the certificate. \| \| \| organization string \| \| Specifies the Organization attribute for the certificate. \| \| \| state string \| \| Specifies the State or Province attribute for the certificate. \| \| key\_name string \| Default:"server.key" \| Specifies the full name of the key file. If the name is not default `server.key`, the module will configure `httpd` to use them prior to restarting the `httpd` daemon. \| \| key\_size integer \| Choices:* 512 * 1024 * 2048 * 4096 Default:2048 \| Specifies the desired key size in bits. Mandatory option when generating a new certificate. \| \| new\_cert boolean \| Choices:* no ← * yes \| Specified if the module should generate a new certificate. When `yes`, the device certificate and key will be replaced. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:22 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| ssh\_keyfile path \| \| Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* cli ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Update expired certificate bigip_device_certificate: days_valid: 365 provider: password: secret server: lb.mydomain.com user: admin transport: cli server_port: 22 delegate_to: localhost - name: Update expired certificate non-default names bigip_device_certificate: days_valid: 60 cert_name: custom.crt key_name: custom.key provider: password: secret server: lb.mydomain.com user: admin transport: cli server_port: 22 delegate_to: localhost - name: Force update not expired certificate bigip_device_certificate: days_valid: 365 force: yes provider: password: secret server: lb.mydomain.com user: admin transport: cli server_port: 22 delegate_to: localhost - name: Create a new certificate to replace expired certificate bigip_device_certificate: days_valid: 365 new_cert: yes issuer: country: US state: WA common_name: foobar.foo.local provider: password: secret server: lb.mydomain.com user: admin transport: cli server_port: 22 delegate_to: localhost - name: Force create a new custom named certificate to replace not expired certificate bigip_device_certificate: days_valid: 365 cert_name: custom.crt key_name: custom.key new_cert: yes force: yes issuer: country: US state: WA common_name: foobar.foo.local key_size: 2048 provider: password: secret server: lb.mydomain.com user: admin transport: cli server_port: 22 delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cert\_name string \| changed \| The full name of the certificate file. Sample: common.crt \| \| days\_valid integer \| changed \| The interval for which the self-signed certificate is valid. Sample: 365 \| \| issuer complex \| changed \| Specifies certificate properties. \| \| \| common\_name string \| changed \| The Common Name attribute of the certificate. Sample: foo.bar.local \| \| \| country string \| changed \| The Country name attribute of the certificate. Sample: US \| \| \| division string \| changed \| The department name attribute of the certificate. Sample: IT \| \| \| email string \| changed \| The domain administrator's email address. Sample: [email protected] \| \| \| locality string \| changed \| The city or town name attribute of the certificate. Sample: Seattle \| \| \| organization string \| changed \| The Organization attribute of the certificate. Sample: F5 \| \| \| state string \| changed \| The State or Province attribute of the certificate. Sample: WA \| \| key\_name string \| changed \| The full name of the key file. Sample: common.key \| \| key\_size integer \| changed \| The desired key size in bits. Sample: 2048 \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_device_httpd – Manage HTTPD related settings on a BIG-IP system f5networks.f5\_modules.bigip\_device\_httpd – Manage HTTPD related settings on a BIG-IP system ============================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_httpd`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages HTTPD related settings on the BIG-IP. These settings are useful when you want to set GUI timeouts and other TMUI related settings. Requirements ------------ The below requirements are needed on the host that executes this module. * requests Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allow list / elements=string \| \| If you have enabled HTTPD access, specifies the IP address or address range for other systems that can communicate with this system. To specify all addresses, use the value `all`. An IP address can be specified, such as 172.27.1.10. IP ranges can be specified, such as 172.27.\.\ or 172.27.0.0/255.255.0.0. \| \| auth\_name string \| \| Sets the BIG-IP authentication realm name. \| \| auth\_pam\_dashboard\_timeout boolean \| Choices:* no * yes \| Sets whether or not the BIG-IP dashboard will timeout. \| \| auth\_pam\_idle\_timeout integer \| \| Sets the GUI timeout for automatic logout, in seconds. \| \| auth\_pam\_validate\_ip boolean \| Choices:* no * yes \| Sets the authPamValidateIp setting. \| \| fast\_cgi\_timeout integer \| \| Sets the timeout of FastCGI. \| \| hostname\_lookup boolean \| Choices:* no * yes \| Sets whether or not to display the hostname, if possible. \| \| log\_level string \| Choices:* alert * crit * debug * emerg * error * info * notice * warn \| Sets the minimum HTTPD log level. \| \| max\_clients integer \| \| Sets the maximum number of clients that can connect to the GUI at once. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| redirect\_http\_to\_https boolean \| Choices:* no * yes \| Whether or not to redirect HTTP requests to the GUI to HTTPS. \| \| ssl\_cipher\_suite raw \| \| Specifies the ciphers the system uses. The values in the suite are separated by colons (:). Can be specified in either a string or list form. The list form is the recommended way to provide the cipher suite. See examples for usage. Use the value `default` to set the cipher suite to the system default. This value is equivalent to specifying a list of `ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384,ECDHE-RSA-AES128-SHA,ECDHE-RSA-AES256-SHA, ECDHE-RSA-AES128-SHA256,ECDHE-RSA-AES256-SHA384,ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384,ECDHE-ECDSA-AES128-SHA,ECDHE-ECDSA-AES256-SHA, ECDHE-ECDSA-AES128-SHA256,ECDHE-ECDSA-AES256-SHA384,AES128-GCM-SHA256, AES256-GCM-SHA384,AES128-SHA,AES256-SHA,AES128-SHA256,AES256-SHA256, ECDHE-RSA-DES-CBC3-SHA,ECDHE-ECDSA-DES-CBC3-SHA,DES-CBC3-SHA`. \| \| ssl\_port integer \| \| The HTTPS port on which the system should listen. \| \| ssl\_protocols raw \| \| The list of SSL protocols to accept on the management console. A space-separated list of tokens in the format accepted by the Apache mod\_ssl SSLProtocol directive. Can be specified in either a string or list form. The list form is the recommended way to provide the cipher suite. See examples for usage. Use the value `default` to set the SSL protocols to the system default. This value is equivalent to specifying a list of `all,-SSLv2,-SSLv3`. \| Notes ----- Note * Requires the requests Python package on the host. This is as easy as running `pip install requests`. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set the BIG-IP authentication realm name bigip_device_httpd: auth_name: BIG-IP provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set the auth pam timeout to 3600 seconds bigip_device_httpd: auth_pam_idle_timeout: 1200 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set the validate IP settings bigip_device_httpd: auth_pam_validate_ip: on provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set SSL cipher suite by list bigip_device_httpd: ssl_cipher_suite: - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-RSA-AES128-SHA - AES256-SHA256 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set SSL cipher suite by string bigip_device_httpd: ssl_cipher_suite: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-SHA:AES256-SHA256 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set SSL protocols by list bigip_device_httpd: ssl_protocols: - all - -SSLv2 - -SSLv3 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set SSL protocols by string bigip_device_httpd: ssl_protocols: all -SSLv2 -SSLv3 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| auth\_name string \| changed \| The new authentication realm name. Sample: foo \| \| auth\_pam\_dashboard\_timeout boolean \| changed \| Whether or not the BIG-IP dashboard will timeout. \| \| auth\_pam\_idle\_timeout string \| changed \| The new number of seconds for GUI timeout. Sample: 1200 \| \| auth\_pam\_validate\_ip boolean \| changed \| The new authPamValidateIp setting. Sample: True \| \| fast\_cgi\_timeout integer \| changed \| The new timeout of FastCGI. Sample: 500 \| \| hostname\_lookup boolean \| changed \| Whether or not to display the hostname, if possible. Sample: True \| \| log\_level string \| changed \| The new minimum HTTPD log level. Sample: crit \| \| max\_clients integer \| changed \| The new maximum number of clients that can connect to the GUI at once. Sample: 20 \| \| redirect\_http\_to\_https boolean \| changed \| Whether or not to redirect HTTP requests to the GUI to HTTPS. Sample: True \| \| ssl\_cipher\_suite string \| changed \| The new ciphers the system uses. Sample: ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-SHA \| \| ssl\_cipher\_suite\_list string \| changed \| List of the new ciphers the system uses. Sample: ['ECDHE-RSA-AES256-GCM-SHA384', 'ECDHE-RSA-AES128-SHA'] \| \| ssl\_port integer \| changed \| The new HTTPS port to listen on. Sample: 10443 \| \| ssl\_protocols string \| changed \| The new list of SSL protocols to accept on the management console. Sample: all -SSLv2 -SSLv3 \| ### Authors * Joe Reifel (@JoeReifel) * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_configsync_action – Perform different actions related to config-sync f5networks.f5\_modules.bigip\_configsync\_action – Perform different actions related to config-sync =================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_configsync_action`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Allows running different config-sync actions. These actions allow you to manually sync your configuration across multiple BIG-IPs when those devices are in an HA pair. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| device\_group string / required \| \| The device group on which you want to perform config-sync actions. \| \| overwrite\_config boolean \| Choices:* no ← * yes \| Indicates the sync operation overwrites the configuration on the target. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| sync\_device\_to\_group boolean \| Choices:* no * yes \| Specifies the system synchronizes configuration data from this device to other members of the device group. In this case, the device will do a "push" to all the other devices in the group. This option is mutually exclusive with the `sync_group_to_device` option. \| \| sync\_group\_to\_device boolean \| Choices:* no * yes \| Specifies the system synchronizes configuration data from the device with the most recent configuration. In this case, the device will do a "pull" from the most recently updated device. This option is mutually exclusive with the `sync_device_to_group` options. \| Notes ----- Note * Requires the objectpath Python package on the host. This is as easy as running `pip install objectpath`. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Sync configuration from device to group bigip_configsync_action: device_group: foo-group sync_device_to_group: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Sync configuration from most recent device to the current host bigip_configsync_action: device_group: foo-group sync_group_to_device: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Perform an initial sync of a device to a new device group bigip_configsync_action: device_group: new-device-group sync_device_to_group: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_interface – Module to manage BIG-IP physical interfaces. f5networks.f5\_modules.bigip\_interface – Module to manage BIG-IP physical interfaces. ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_interface`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Module to manage BIG-IP physical interfaces. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bundle string \| Choices:* enabled * disabled * not-supported \| Enables or disables bundle capability. This option is only supported on select hardware platforms and interfaces. Attempting to enable this option on a `VE` or any other unsupported platform/interface will result in module run failure. \| \| bundle\_speed string \| Choices:* 100G * 40G * not-supported \| Sets the bundle speed, which is applicable only when the bundle is `yes`. This option is only supported on selected hardware platforms and interfaces. Attempting to enable this option on a `VE` or any other unsupported platform/interface will result in module run failure. \| \| description string \| \| User defined description. \| \| enabled boolean \| Choices:* no * yes \| Specifies the current status of the interface. When `yes`, enables the interface to pass traffic. When `no`, disables the interface from passing traffic. \| \| flow\_control string \| Choices:* none * rx * tx * tx-rx \| Specifies how the system controls the sending of PAUSE frames. When `tx-rx`, the interface honors pause frames from its partner, and also generates pause frames when necessary. When `tx`, the interface ignores pause frames from its partner, and generates pause frames when necessary. When `rx`, the interface honors pause frames from its partner, but does not generate pause frames. When (none), the flow control is disabled on the interface. \| \| force\_gigabit\_fiber boolean \| Choices:* no * yes \| Enables or disables forcing of gigabit fiber media. When `yes` for a gigabit fiber interface, the media setting will be forced, and no auto-negotiation will be performed. When `no` auto-negotiation will be performed with just a single gigabit fiber option advertised. \| \| forward\_error\_correction string \| Choices:* enabled * disabled * not-supported * auto \| Enables or disables IEEE 802.3bm Clause 91 Reed-Solomon Forward Error Correction on 100G interfaces. Not valid for LR4 media. This option is only supported on selected hardware platforms and interfaces. Attempting to enable this option on a `VE` or any other unsupported platform/interface will result in module run failure. \| \| lldp\_admin string \| Choices:* disable * rxonly * txonly * txrx \| Specifies LLDP settings on an interface level. When `disabled`, the interface neither transmits (sends) LLDP messages to nor receives LLDP messages from neighboring devices. When `txonly`, the interface transmits LLDP messages to neighbor devices, but does not receive LLDP messages from neighbor devices. When `rxonly`, the interface receives LLDP messages from neighbor devices, but does not transmit LLDP messages to neighbor devices. When `txrx`, the interface transmits LLDP messages to and receives LLDP messages from neighboring devices. \| \| lldp\_tlvmap integer \| \| Specifies the content of an LLDP message being sent or received. Each LLDP attribute specified with this setting is optional and is in the form of Type, Length, Value (TLV). The three mandatory TLVs not taken into account when calculating this value are: `Chassis ID`, `Port ID`, and `TTL`. The optional attributes that are available have a specific TLV numeric value mapped to them. The `Port Description` attribute has a TLV value of `8`. The `System Name` attribute has a TLV value of `16`. The `System Description` attribute has a TLV value of `32`. The `System Capabilities` attribute has a TLV value of `64`. The `Management Address` attribute has a TLV value of `128`. The `Port VLAN ID` attribute has a TLV value of `256`. The `VLAN Name` attribute has a TLV value of `512`. The `Port and Protocol VLAN ID` attribute has a TLV value of `1024`. The `Protocol Identity` attribute has a TLV value of `2048`. The `MAC/PHY Config Status` attribute has a TLV value of `4096`. The `Link Aggregation` attribute has a TLV value of `8192`. The `Max Frame Size` attribute has a TLV value of `32768`. The `Product Model` attribute has a TLV value of `65536`. The `lldp_tlvmap` is a numeric value that is a sum of all TLV values of selected attributes. Setting `lldp_tlvmap` to `0` will remove all attributes from the interface. Setting `lldp_tlvmap` to `114680` will add all attributes to the interface. \| \| media\_fixed string \| Choices:* 100000-FD * 100000LR4-FD * 10000LR-FD * 10000T-FD * 1000SX-FD * 100TX-FD * 10T-HD * 20000-FD * 40000LR4-FD * 100000AR4-FD * 100000SR4-FD * 10000SFPCU-FD * 1000CX-FD * 1000T-FD * 100TX-HD * 12000-FD * 21000-FD * 40000SR4-FD * 100000CR4-FD * 10000ER-FD * 10000SR-FD * 1000LX-FD * 1000T-HD * 10T-FD * 16000-FD * 40000-FD * 42000-FD * auto * no-phy \| Specifies the settings for a fixed (non-pluggable) interface. Use this option only with a combo port to specify the media type for the fixed interface, when it is not the preferred port. \| \| media\_sfp string \| Choices:* 100000-FD * 100000LR4-FD * 10000LR-FD * 10000T-FD * 1000SX-FD * 100TX-FD * 10T-HD * 20000-FD * 40000LR4-FD * 100000AR4-FD * 100000SR4-FD * 10000SFPCU-FD * 1000CX-FD * 1000T-FD * 100TX-HD * 12000-FD * 21000-FD * 40000SR4-FD * 100000CR4-FD * 10000ER-FD * 10000SR-FD * 1000LX-FD * 1000T-HD * 10T-FD * 16000-FD * 40000-FD * 42000-FD * auto * no-phy \| Specifies the settings for an SFP (pluggable) interface. Use this option only with a combo port to specify the media type for the SFP interface, when it is not the preferred port. \| \| name string / required \| \| Specifies the name of the interface to manage. \| \| port\_fwd\_mode string \| Choices:* l3 * passive * virtual-wire \| Specifies the operation mode. \| \| prefer\_port string \| Choices:* sfp * fixed \| Indicates which side of a combo port the interface uses, if both sides have the potential for an external link. The default value for a combo port is sfp. Do not use this option for non-combo ports. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| sflow dictionary \| \| Specifies sFlow settings for the interface. \| \| \| poll\_interval integer \| \| Specifies the maximum interval between two pollings, in seconds. For this setting to take effect, `poll_interval_global` must be set to `no`. The valid range is 0 - 4294967295. \| \| \| poll\_interval\_global boolean \| Choices:* no * yes \| Specifies whether the global interface `poll_interval` setting overrides the object-level `poll_interval` setting. When `yes` the `poll_interval` setting does not take effect. \| \| stp boolean \| Choices:* no * yes \| Enables or disables STP. \| \| stp\_auto\_edge\_port boolean \| Choices:* no * yes \| Sets STP automatic edge port detection for the interface. When `yes`, the system monitors the interface for incoming STP, RSTP, or MSTP packets. If no such packets are received for a sufficient period of time (about three seconds), the interface is automatically given edge port status. When `no`, the system never gives the interface edge port status automatically. Any STP setting set on a per-interface basis applies to all spanning tree instances. \| \| stp\_edge\_port boolean \| Choices:* no * yes \| Specifies whether the interface connects to an end station instead of another spanning tree bridge. \| \| stp\_link\_type string \| Choices:* auto * p2p * shared \| Specifies the STP link type for the interface. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Update Interface Settings bigip_interface: name: 1.1 stp: yes stp_auto_edge_port: no stp_edge_port: yes stp_link_type: shared description: my description flow_control: tx lldp_admin: txrx lldp_tlvmap: 8 force_gigabit_fiber: no sflow: - poll_interval: 10 - poll_interval_global: no provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Disable Interface bigip_interface: name: 1.1 enabled: no provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Change sflow interface settings bigip_interface: name: 1.1 sflow: - poll_interval: 0 - poll_interval_global: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| bundle string \| changed \| Enables or disables bundle capability. Sample: not-supported \| \| bundle\_speed string \| changed \| The bundle speed. Sample: 100G \| \| description string \| changed \| User defined description. Sample: my description \| \| enabled boolean \| changed \| The current status of the interface. Sample: True \| \| flow\_control string \| changed \| Specifies how the system controls the sending of PAUSE frames. Sample: tx \| \| force\_gigabit\_fiber boolean \| changed \| Enables or disables forcing of gigabit fiber media. Sample: True \| \| forward\_error\_correction string \| changed \| Enables or disables Forward Error Correction. Sample: auto \| \| lldp\_admin string \| changed \| The LLDP settings on an interface level. Sample: txrx \| \| lldp\_tlvmap integer \| changed \| The content of an LLDP message being sent or received. Sample: 136 \| \| media\_fixed string \| changed \| The settings for a fixed interface. Sample: 100000-FD \| \| media\_sfp string \| changed \| The settings for a SFP interface. Sample: 100000-FD \| \| port\_fwd\_mode string \| changed \| The operation mode. Sample: passive \| \| prefer\_port string \| changed \| The side of a combo port the interface uses. Sample: fixed \| \| sflow complex \| changed \| Specifies sFlow settings for the interface. Sample: hash/dictionary of values \| \| \| poll\_interval integer \| changed \| The maximum interval in seconds between two pollings. Sample: 128 \| \| \| poll\_interval\_global boolean \| changed \| The global sFlow settings override. Sample: True \| \| stp boolean \| changed \| Enables or disables STP. \| \| stp\_auto\_edge\_port boolean \| changed \| Sets STP automatic edge port detection for the interface. Sample: True \| \| stp\_edge\_port boolean \| changed \| Specifies whether the interface connects to an end station instead of another spanning tree bridge. \| \| stp\_link\_type string \| changed \| The STP link type for the interface. Sample: shared \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_monitor_smtp – Manage SMTP monitors on a BIG-IP f5networks.f5\_modules.bigip\_monitor\_smtp – Manage SMTP monitors on a BIG-IP ============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_smtp`. New in version 1.1.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage SMTP monitors on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| app\_service string \| \| The iApp service to be associated with this profile. When no service is specified, the default is None. \| \| debug boolean \| Choices:* no * yes \| Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. When `yes` the system redirects error messages and additional information to the `/var/log/monitors/<monitor_name>-<node_name>-<port>.log` file. \| \| description string \| \| The description of the monitor. \| \| domain string \| \| Specifies the domain name to check. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. This value must be less than the `timeout` value. When creating a new monitor, if this parameter is not provided, the default `5` will be used. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| manual\_resume* boolean \| Choices:* no * yes \| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to `yes`, you must manually re-enable the resource before the system can use it for load balancing connections. When creating a new monitor, if this parameter is not specified, the default value is `no`. When `yes`, specifies you must manually re-enable the resource after an unsuccessful monitor check. When `no`, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. \| \| name string / required \| \| Specifies the name of the monitor. \| \| parent string \| \| The parent template of this monitor template. Once this value has been set, it cannot be changed. When creating a new monitor, if this parameter is not specified, the default is the system-supplied `smtp` monitor. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must specify a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of `0` will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be `0`. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value will be `31`. \| \| up\_interval integer \| \| Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. When creating a new monitor, if this parameter is not provided, the default `0` will be used. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create SMTP Monitor bigip_monitor_smtp: state: present ip: 10.10.10.10 name: my_smtp_monitor domain: foo.com provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove SMTP Monitor bigip_monitor_smtp: state: absent name: my_smtp_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| app\_service string \| changed \| The iApp service associated with this monitor. Sample: /Common/good\_service.app/good\_service \| \| debug boolean \| changed \| Whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| domain string \| changed \| Specifies the domain name to check. Sample: bigipinternal.com \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| manual\_resume boolean \| changed \| Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True \| \| parent string \| changed \| The parent monitor. Sample: /Common/foo\_smtp \| \| port string \| changed \| Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Sample: 80 \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| up\_interval integer \| changed \| Interval for the system to use to perform the health check when a resource is up. \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_snmp_dca – Manages BIG-IP SNMP data collecting agent (DCA) monitors f5networks.f5\_modules.bigip\_monitor\_snmp\_dca – Manages BIG-IP SNMP data collecting agent (DCA) monitors =========================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_snmp_dca`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * The BIG-IP has an SNMP data collecting agent (DCA) that can query remote SNMP agents of various types, including the UC Davis agent (UCD) and the Windows 2000 Server agent (WIN2000). Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| agent\_type string \| Choices:* UCD * WIN2000 * GENERIC \| Specifies the SNMP agent running on the monitored server. When creating a new monitor, the default is `UCD` (UC-Davis). \| \| community string \| \| Specifies the community name the system must use to authenticate with the host server through SNMP. When creating a new monitor, the default value is `public`. This value is case sensitive. \| \| cpu\_coefficient string \| \| Specifies the coefficient the system uses to calculate the weight of the CPU threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is `1.5`. \| \| cpu\_threshold integer \| \| Specifies the maximum acceptable CPU usage on the target server. When creating a new monitor, the default is `80` percent. \| \| description string \| \| Specifies descriptive text that identifies the monitor. \| \| disk\_coefficient string \| \| Specifies the coefficient the system uses to calculate the weight of the disk threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is `2.0`. \| \| disk\_threshold integer \| \| Specifies the maximum acceptable disk usage on the target server. When creating a new monitor, the default is `90` percent. \| \| interval integer \| \| Specifies the frequency, in seconds, at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. When creating a new monitor, the default is `10`. \| \| memory\_coefficient string \| \| Specifies the coefficient the system uses to calculate the weight of the memory threshold in the dynamic ratio load balancing algorithm. When creating a new monitor, the default is `1.0`. \| \| memory\_threshold integer \| \| Specifies the maximum acceptable memory usage on the target server. When creating a new monitor, the default is `70` percent. \| \| name string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/snmp\_dca" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `snmp_dca` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked 'up'. A value of 0, means that the resource is marked up immediately upon receipt of the first correct response. When creating a new monitor, the default is `0`. \| \| timeout integer \| \| Specifies the number of seconds the target has in which to respond to the monitor request. When creating a new monitor, the default is `30` seconds. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that `timeout` and `time_until_up` combine to control when a resource is set to up. \| \| version string \| Choices:* v1 * v2c \| Specifies the version of SNMP the host server uses. When creating a new monitor, the default is `v1`. When `v1`, specifies the host server uses SNMP version 1. When `v2c`, specifies that the host server uses SNMP version 2c. \| Notes ----- Note * Requires BIG-IP software version >= 12 * This module does not support the `variables` option because it is broken in the REST API and does not function correctly in `tmsh`; for example you cannot remove user-defined params. Therefore, there is no way to automatically configure it. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create SNMP DCS monitor bigip_monitor_snmp_dca: name: my_monitor state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove TCP Echo Monitor bigip_monitor_snmp_dca: name: my_monitor state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| agent\_type string \| changed \| The new agent type to be used by the monitor. Sample: UCD \| \| community string \| changed \| The new community for the monitor. Sample: foobar \| \| cpu\_coefficient float \| changed \| The new CPU coefficient. Sample: 2.4 \| \| cpu\_threshold integer \| changed \| The new CPU threshold. Sample: 85 \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| disk\_coefficient float \| changed \| The new disk coefficient. Sample: 10.2 \| \| disk\_threshold integer \| changed \| The new disk threshold. Sample: 34 \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| memory\_coefficient float \| changed \| The new memory coefficient. Sample: 6.4 \| \| memory\_threshold integer \| changed \| The new memory threshold. Sample: 50 \| \| parent string \| changed \| New parent template of the monitor. Sample: snmp\_dca \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| version string \| changed \| The new new SNMP version to be used by the monitor. Sample: v2c \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_snat_translation – Manage SNAT translations on a BIG-IP f5networks.f5\_modules.bigip\_snat\_translation – Manage SNAT translations on a BIG-IP ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_snat_translation`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage SNAT translations on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| Specifies the IP address of the SNAT translation. When `state` is `present`, `enabled`, or `disabled`, this parameter is required. This parameter cannot be updated after it is set. aliases: ip \| \| arp boolean \| Choices:* no * yes \| If `yes`, specifies the NAT sends ARP requests. \| \| connection\_limit integer \| \| Specifies a limit on the number of connections a translation address must reach before it no longer initiates a connection. The default value of `0` indicates the setting is disabled. The accepted value range is `0 - 65535`. \| \| description string \| \| Description of snat-translation. `none or ''` sets a default description of null. \| \| ip\_idle\_timeout string \| \| Specifies the amount of time connections to an IP address initiated using a SNAT address are allowed to remain idle before being automatically disconnected. `indefinite` prevents the connection from timing out. The accepted value range is `0 - 4294967295` seconds. Specifying `indefinite` sets it to the maximum value. \| \| name string / required \| \| The name of SNAT translation. \| \| partition string \| \| Device partition to manage resources on. Required with state `absent` when a partition other than Common is used. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent * enabled * disabled \| The SNAT translation state. If `absent`, deletes the SNAT translation if it exists. `present` creates the SNAT translation and enables it. If `enabled`, enables the SNAT translation if it exists. If `disabled`, creates the SNAT translation if needed, and sets the state to `disabled`. \| \| tcp\_idle\_timeout string \| \| Specifies the amount of time that TCP connections initiated using a SNAT address are allowed to remain idle before being automatically disconnected. `indefinite` prevents the connection from timing out. The accepted value range is `0 - 4294967295` seconds. Specifying `indefinite` sets it to the maximum value. \| \| traffic\_group string \| \| The traffic group for the snat-translation address. When creating a new address, if this value is not specified, the default is `/Common/traffic-group-1`. \| \| udp\_idle\_timeout string \| \| Specifies the amount of time UDP connections initiated using a SNAT address are allowed to remain idle before being automatically disconnected. `indefinite` prevents the connection from timing out. The accepted value range is `0 - 4294967295` seconds. Specifying `indefinite` sets it to the maximum value. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a SNAT translation 'my-snat-translation' bigip_snat_translation: name: my-snat-pool state: present address: 10.10.10.10 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Modify a SNAT translation 'my-snat-translation' bigip_snat_translation: name: my-snat-pool state: present address: 10.10.10.10 arp: no connection_limit: 300 ip_idle_timeout: 1800 tcp_idle_timeout: 1800 udp_idle_timeout: 1800 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Disable a SNAT translation 'my-snat-translation' bigip_snat_translation: name: my-snat-pool state: disabled address: 10.10.10.10 arp: no connection_limit: 300 ip_idle_timeout: 1800 tcp_idle_timeout: 1800 udp_idle_timeout: 1800 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Enable a SNAT translation 'my-snat-translation' bigip_snat_translation: name: my-snat-pool state: enabled address: 10.10.10.10 arp: no connection_limit: 300 ip_idle_timeout: 1800 tcp_idle_timeout: 1800 udp_idle_timeout: 1800 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create using partition other then /Common on a SNAT translation 'my-new-snat-translation' bigip_snat_translation: name: my-new-snat-pool state: enabled address: 10.10.10.10 arp: no connection_limit: 300 ip_idle_timeout: 1800 partition: ansible tcp_idle_timeout: 1800 udp_idle_timeout: 1800 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Modify using traffic group other then /Common/traffic-group-1 on a SNAT translation 'my-new-snat-translation' bigip_snat_translation: name: my-new-snat-pool state: enabled address: 10.10.10.10 arp: no connection_limit: 300 ip_idle_timeout: 1800 partition: ansible tcp_idle_timeout: 1800 traffic_group: /Common/ansible udp_idle_timeout: 1800 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address string \| changed and success \| IP address used for SNAT translation. Sample: 10.10.10.10 \| \| arp boolean \| changed \| Whether snat-translation sends arp requests. Sample: True \| \| connection\_limit integer \| changed \| The new connection limit of the virtual address. Sample: 1000 \| \| description string \| changed \| Description of the snat-translation. Sample: My snat-translation \| \| ip\_idle\_timeout string \| changed \| IP idle timeout value for the snat-translation. Sample: 300 \| \| state string \| changed \| The new state of the snat-translation. Sample: disabled \| \| tcp\_idle\_timeout string \| changed \| TCP idle timeout value for the snat-translation. Sample: 1800 \| \| traffic\_group string \| changed \| Assigned traffic group. Sample: /Common/traffic-group-1 \| \| udp\_idle\_timeout string \| changed \| UDP idle timeout value for the snat-translation. Sample: indefinite \| ### Authors * Greg Crosby (@crosbygw) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_apm_policy_import – Manage BIG-IP APM policy or APM access profile imports f5networks.f5\_modules.bigip\_apm\_policy\_import – Manage BIG-IP APM policy or APM access profile imports ========================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_apm_policy_import`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP APM policy or APM access profile imports. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| force boolean \| Choices:* no ← * yes \| When set to `yes` any existing policy with the same name will be overwritten by the new import. If a policy does not exist, this setting is ignored. \| \| name string / required \| \| The name of the APM policy or APM access profile to create or override. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| reuse\_objects boolean \| Choices:* no * yes ← \| When set to `yes` and objects referred within the policy exist on the BIG-IP, those will be used instead of the objects defined in the policy. Reusing existing objects reduces configuration size. The configuration of existing objects might differ to the configuration of the objects defined in the policy! \| \| source path \| \| Full path to a file to be imported into the BIG-IP APM. \| \| type string \| Choices:* profile\_access ← * access\_policy * profile\_api\_protection \| Specifies the type of item to export from the device. \| Notes ----- Note * Due to ID685681 it is not possible to execute ng\_\* tools via REST API on v12.x and 13.x, once this is fixed this restriction will be removed. * Requires BIG-IP >= 14.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Import APM profile bigip_apm_policy_import: name: new_apm_profile source: /root/apm_profile.tar.gz provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Import APM policy bigip_apm_policy_import: name: new_apm_policy source: /root/apm_policy.tar.gz type: access_policy provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Override existing APM policy bigip_asm_policy: name: new_apm_policy source: /root/apm_policy.tar.gz force: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Import APM profile without re-using existing configuration objects bigip_apm_policy_import: name: new_apm_profile source: /root/apm_profile.tar.gz reuse_objects: false provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| force boolean \| changed \| Set when overwriting an existing policy or profile. Sample: True \| \| name string \| changed \| Name of the APM policy or APM access profile to be created/overwritten. Sample: APM\_policy\_global \| \| reuse\_objects boolean \| changed \| Set when reusing existing objects on the BIG-IP. Sample: True \| \| source string \| changed \| Local path to APM policy file. Sample: /root/some\_policy.tar.gz \| \| type string \| changed \| Set to specify type of item to export. Sample: access\_policy \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_firewall_port_list – Manage port lists on BIG-IP AFM f5networks.f5\_modules.bigip\_firewall\_port\_list – Manage port lists on BIG-IP AFM ==================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_port_list`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages the AFM (Advanced Firewall Manager) port lists on a BIG-IP. This module can be used to add and remove port list entries. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the port list. \| \| name string / required \| \| Specifies the name of the port list. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port\_lists list / elements=string \| \| Simple list of existing port lists to add to this list. Port lists can be specified in either their fully qualified name (/Common/foo) or their short name (foo). If a short name is used, the `partition` argument will automatically be prepended to the short name. \| \| port\_ranges list / elements=string \| \| A list of port ranges where the range starts with a port number, is followed by a dash (-), and then a second number. If the first number is greater than the second number, the numbers will be reversed to be properly formatted, for example 90-78 would become 78-90. \| \| ports list / elements=string \| \| Simple list of port values to add to the list. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the address list and entries exists. When `absent`, ensures the address list is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a simple port list bigip_firewall_port_list: name: foo ports: - 80 - 443 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Override the above list of ports with a new list bigip_firewall_port_list: name: foo ports: - 3389 - 8080 - 25 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create port list with series of ranges bigip_firewall_port_list: name: foo port_ranges: - 25-30 - 80-500 - 50-78 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Use multiple types of port arguments bigip_firewall_port_list: name: foo port_ranges: - 25-30 - 80-500 - 50-78 ports: - 8080 - 443 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove port list bigip_firewall_port_list: name: foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create port list from a file with one port per line bigip_firewall_port_list: name: lot-of-ports ports: "{{ lookup('file', 'my-large-port-list.txt').split('\n') }}" state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the port list. Sample: My port list \| \| port\_lists list / elements=string \| changed \| The new list of port list names applied to the port list. Sample: ['/Common/list1', '/Common/list2'] \| \| port\_ranges list / elements=string \| changed \| The new list of port ranges applied to the port list. Sample: ['80-100', '200-8080'] \| \| ports list / elements=string \| changed \| The new list of ports applied to the port list. Sample: [80, 443] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_profile_dns – Manage DNS profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_dns – Manage DNS profiles on a BIG-IP ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_dns`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage DNS profiles on a BIG-IP. There are many DNS profiles options, each with their own adjustments to the standard `dns` profile. Users of this module should be aware that many of the configurable options have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cache\_name string \| \| Specifies the user-created cache the system uses to cache DNS responses. When you select a cache for the system to use, you must also set `enable_dns_cache` to `yes` \| \| enable\_cache boolean \| Choices:* no * yes \| Specifies whether the system caches DNS responses. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. When `yes`, the BIG-IP system caches DNS responses handled by the virtual servers associated with this profile. When you enable this setting, you must also specify a value for `cache_name`. When `no`, the BIG-IP system does not cache DNS responses handled by the virtual servers associated with this profile. However, the profile retains the association with the DNS cache in the `cache_name` parameter. Disable this setting when you want to debug the system. \| \| enable\_dns\_express boolean \| Choices:* no * yes \| Specifies whether the DNS Express engine is enabled. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The DNS Express engine receives zone transfers from the authoritative DNS server for the zone. If the `enable_zone_transfer` setting is also `yes` on this profile, the DNS Express engine also responds to zone transfer requests made by the nameservers configured as zone transfer clients for the DNS Express zone. \| \| enable\_dns\_firewall boolean \| Choices:* no * yes \| Specifies whether the DNS firewall is enabled. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| enable\_dnssec boolean \| Choices:* no * yes \| Specifies whether the system signs responses with DNSSEC keys and replies to DNSSEC specific queries (for example, DNSKEY query type). When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| enable\_gtm boolean \| Choices:* no * yes \| Specifies whether the system uses Global Traffic Manager (now BIG-IP DNS) to manage the response. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| enable\_zone\_transfer boolean \| Choices:* no * yes \| Specifies whether the system answers zone transfer requests for a DNS zone created on the system. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The `enable_dns_express` and `enable_zone_transfer` settings on a DNS profile affect how the system responds to zone transfer requests. When the `enable_dns_express` and `enable_zone_transfer` settings are both `yes`, if a zone transfer request matches a DNS Express zone, DNS Express answers the request. When the `enable_dns_express` setting is `no` and the `enable_zone_transfer` setting is `yes`, the BIG-IP system processes zone transfer requests based on the last action and answers the request from local BIND or a pool member. \| \| name string / required \| \| Specifies the name of the DNS profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `dns` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| process\_recursion\_desired boolean \| Choices:* no * yes \| Specifies whether to process client-side DNS packets with Recursion Desired set in the header. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. If set to `no`, processing of the packet is subject to the unhandled-query-action option. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| unhandled\_query\_action string \| Choices:* allow * drop * reject * hint * no-error \| Specifies the action to take when a query does not match a Wide IP or a DNS Express Zone. When `allow`, the BIG-IP system forwards queries to a DNS server or pool member. If a pool is not associated with a listener and the Use BIND Server on BIG-IP setting is set to Enabled, requests are forwarded to the local BIND server. When `drop`, the BIG-IP system does not respond to the query. When `reject`, the BIG-IP system returns the query with the REFUSED return code. When `hint`, the BIG-IP system returns the query with a list of root name servers. When `no-error`, the BIG-IP system returns the query with the NOERROR return code. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| use\_local\_bind boolean \| Choices:* no * yes \| Specifies whether the system forwards non-wide IP queries to the local BIND server on the BIG-IP system. For best performance, disable this setting when using a DNS cache. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a DNS profile bigip_profile_dns: name: foo enable_dns_express: no enable_dnssec: no enable_gtm: no process_recursion_desired: no use_local_bind: no enable_dns_firewall: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cache\_name string \| changed \| Name of the cache used by DNS. Sample: /Common/cache1 \| \| enable\_cache boolean \| changed \| Whether DNS caching is enabled or not. \| \| enable\_dns\_express boolean \| changed \| Whether DNS Express is enabled on the resource or not. Sample: True \| \| enable\_dns\_firewall boolean \| changed \| Whether DNS firewall capability is enabled or not. \| \| enable\_dnssec boolean \| changed \| Whether DNSSEC is enabled on the resource or not. \| \| enable\_gtm boolean \| changed \| Whether GTM is used to manage the resource or not. Sample: True \| \| enable\_zone\_transfer boolean \| changed \| Whether zone transfer are enabled on the resource or not. \| \| process\_recursion\_desired boolean \| changed \| Whether client-side DNS packets are processed with Recursion Desired set. Sample: True \| \| unhandled\_query\_action string \| changed \| What to do with unhandled queries Sample: allow \| \| use\_local\_bind boolean \| changed \| Whether non-wide IP queries are forwarded to the local BIND server or not. \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_vlan – Manage VLANs on a BIG-IP system f5networks.f5\_modules.bigip\_vlan – Manage VLANs on a BIG-IP system ==================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_vlan`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage VLANs on a BIG-IP system Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cmp\_hash string \| Choices:* default * destination-address * source-address * dst-ip * src-ip * dest * destination * source * dst * src \| Specifies how the traffic on the VLAN is disaggregated. The value you select determines the traffic disaggregation method. You can choose to disaggregate traffic based on `source-address` (the source IP address), `destination-address` (destination IP address), or `default`, which specifies the default CMP hash uses L4 ports. When creating a new VLAN, if this parameter is not specified, the default is `default`. \| \| dag\_round\_robin boolean \| Choices:* no * yes \| Specifies whether some of the stateless traffic on the VLAN should be disaggregated in a round-robin order instead of using a static hash. The stateless traffic includes non-IP L2 traffic, ICMP, some UDP protocols, and so on. When creating a new VLAN, if this parameter is not specified, the default is (no). \| \| dag\_tunnel string \| Choices:* inner * outer \| Specifies how the disaggregator (DAG) distributes received tunnel-encapsulated packets to TMM instances. Select `inner` to distribute packets based on information in inner headers. Select `outer` to distribute packets based on information in outer headers without inspecting inner headers. When creating a new VLAN, if this parameter is not specified, the default is `outer`. This parameter is not supported on Virtual Editions (VEs) of BIG-IP. \| \| description string \| \| The description of the VLAN. \| \| fail\_safe boolean \| Choices:* no * yes \| When `yes`, specifies the VLAN takes the specified `fail_safe_action` if the system detects a loss of traffic on this VLAN's interfaces. \| \| fail\_safe\_action string \| Choices:* reboot * restart-all * failover \| Specifies the action the system takes when it does not detect any traffic on this VLAN, and the `fail_safe_timeout` has expired. \| \| fail\_safe\_timeout integer \| \| Specifies the number of seconds a system can run without detecting network traffic on this VLAN before it takes the `fail_safe_action`. \| \| hw\_syn\_cookie boolean added in 1.3.0 of f5networks.f5\_modules \| Choices:* no * yes \| Enables hardware syncookie mode on a VLAN. When `yes`, the hardware per-VLAN SYN cookie protection is triggered when the certain traffic threshold is reached on supported platforms. \| \| interfaces list / elements=dictionary \| \| Interfaces you want to add to the VLAN. This can include both tagged and untagged interfaces, as the `tagging` parameter specifies. This parameter is mutually exclusive with the `untagged_interfaces` and `tagged_interfaces` parameters. \| \| \| interface string \| \| The name of the interface \| \| \| tagging string \| Choices:* tagged * untagged \| Whether the interface is `tagged` or `untagged`. \| \| mtu integer \| \| Specifies the maximum transmission unit (MTU) for traffic on this VLAN. When creating a new VLAN, if this parameter is not specified, the default value used is `1500`. This number must be between 576 to 9198. \| \| name string / required \| \| The VLAN to manage. If the special VLAN `ALL` is specified with the `state` value of `absent`, all VLANs will be removed. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| sflow\_poll\_interval integer \| \| Specifies the maximum interval in seconds between two pollings. \| \| sflow\_sampling\_rate integer \| \| Specifies the ratio of packets observed to the samples generated. \| \| source\_check boolean \| Choices:* no * yes \| When `yes`, specifies the system verifies the return route to an initial packet is the same VLAN from which the packet originated. The system performs this verification only if the `auto_last_hop` option is `no`. \| \| state string \| Choices:* absent * present ← \| The state of the VLAN on the system. When `present`, guarantees the VLAN exists with the provided attributes. When `absent`, removes the VLAN from the system. \| \| tag integer \| \| Tag number for the VLAN. The tag number can be any integer between 1 and 4094. The system automatically assigns a tag number if you do not specify a value. \| \| tagged\_interfaces list / elements=string \| \| Specifies a list of tagged interfaces and trunks you want to configure for the VLAN. Use tagged interfaces or trunks when you want to assign a single interface or trunk to multiple VLANs. This parameter is mutually exclusive with the `untagged_interfaces` and `interfaces` parameters. aliases: tagged\_interface \| \| untagged\_interfaces list / elements=string \| \| Specifies a list of untagged interfaces and trunks you want to configure for the VLAN. This parameter is mutually exclusive with the `tagged_interfaces` and `interfaces` parameters. aliases: untagged\_interface \| Notes ----- Note * Requires BIG-IP versions >= 12.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create VLAN bigip_vlan: name: net1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set VLAN tag bigip_vlan: name: net1 tag: 2345 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add VLAN 2345 as tagged to interface 1.1 bigip_vlan: tagged_interface: 1.1 name: net1 tag: 2345 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Add VLAN 1234 as tagged to interfaces 1.1 and 1.2 bigip_vlan: tagged_interfaces: - 1.1 - 1.2 name: net1 tag: 1234 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cmp\_hash string \| changed \| New traffic disaggregation method. Sample: source-address \| \| dag\_tunnel string \| changed \| The new DAG tunnel setting. Sample: outer \| \| description string \| changed \| The description set on the VLAN. Sample: foo VLAN \| \| fail\_safe boolean \| changed \| The new Fail Safe setting. \| \| fail\_safe\_action string \| changed \| The new Fail Safe Action setting. Sample: reboot \| \| fail\_safe\_timeout integer \| changed \| The new Fail Safe Timeout setting. Sample: 90 \| \| hw\_syn\_cookie boolean \| changed \| Enables hardware syncookie mode on a VLAN. \| \| interfaces list / elements=string \| changed \| Interfaces the VLAN is assigned to. Sample: ['1.1', '1.2'] \| \| partition string \| changed \| The partition the VLAN was created on. Sample: Common \| \| sflow\_poll\_interval integer \| changed \| The new sFlow Polling Interval setting. Sample: 10 \| \| sflow\_sampling\_rate integer \| changed \| The new sFlow Sampling Rate setting. Sample: 20 \| \| source\_check boolean \| changed \| The new Source Check setting. Sample: True \| \| tag integer \| changed \| The ID of the VLAN. Sample: 2345 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_ucs – Manage upload, installation, and removal of UCS files f5networks.f5\_modules.bigip\_ucs – Manage upload, installation, and removal of UCS files ========================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ucs`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manage the upload, installation, and removal of UCS files on a BIG-IP system. A user configuration set (UCS) is a backup file that contains BIG-IP configuration data that can be used to fully restore a BIG-IP system in the event of a failure or RMA replacement. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| force boolean \| Choices:* no ← * yes \| If `yes`, the system uploads the file every time and replaces the file on the device. If `no`, the file is only uploaded if it does not already exist. Generally should only be `yes` in cases where you believe the image was corrupted during upload. \| \| include\_chassis\_level\_config boolean \| Choices:* no * yes \| During restoration of the UCS file, includes chassis level configuration that is shared among boot volume sets. For example, the cluster default configuration. \| \| no\_license boolean \| Choices:* no * yes \| Performs a full restore of the UCS file and all the files it contains, with the exception of the license file. The option must be used to restore a UCS on RMA (Returned Materials Authorization) devices. \| \| no\_platform\_check boolean \| Choices:* no * yes \| Bypasses the platform check and allows installation of a UCS that was created using a different platform. By default (without this option), installation of a UCS created from a different platform is not allowed. \| \| passphrase string \| \| Specifies the passphrase that is necessary to load the specified UCS file. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| reset\_trust boolean \| Choices:* no * yes \| When specified, the device and trust domain certs and keys are not loaded from the UCS. Instead, a new set is generated. \| \| state string \| Choices:* absent * installed * present ← \| When `installed`, ensures the UCS is uploaded and installed on the system. When `present`, ensures the UCS is uploaded. When `absent`, the UCS is removed from the system. When `installed`, the uploading of the UCS is idempotent, however the installation of that configuration is not idempotent. \| \| ucs string / required \| \| The path to the UCS file to install. The parameter must be provided if the `state` is either `installed` or `activated`. When `state` is `absent`, the full path for this parameter is ignored and only the filename is used to select a UCS for removal. Therefore you could specify `/foo/bar/test.ucs` and this module would only look for `test.ucs`. \| Notes ----- Note * Only the most basic checks are performed by this module. Other checks and considerations need to be taken into account. See <https://support.f5.com/kb/en-us/solutions/public/11000/300/sol11318.html> * This module does not handle devices with the FIPS 140 HSM. * This module does not handle BIG-IPs systems on the 6400, 6800, 8400, or 8800 hardware platforms. * This module does not verify the new or replaced SSH keys from the UCS file are synchronized between the BIG-IP system and the SCCP. * This module does not support the ‘rma’ option. * This module does not support restoring a UCS archive on a BIG-IP 1500, 3400, 4100, 6400, 6800, or 8400 hardware platforms other than the system from which the backup was created. * The UCS restore operation restores the full configuration only if the hostname of the target system matches the hostname on which the UCS archive was created. If the hostname does not match, only the shared configuration is restored. You can ensure hostnames match by using the `bigip_hostname` Ansible module in a task before using this module. * This module does not support re-licensing a BIG-IP restored from a UCS. * This module does not support restoring encrypted archives on replacement RMA unit. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Upload UCS bigip_ucs: ucs: /root/bigip.localhost.localdomain.ucs state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Install (upload, install) UCS. bigip_ucs: ucs: /root/bigip.localhost.localdomain.ucs state: installed provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Install (upload, install) UCS without installing the license portion bigip_ucs: ucs: /root/bigip.localhost.localdomain.ucs state: installed no_license: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Install (upload, install) UCS except the license, and bypassing the platform check bigip_ucs: ucs: /root/bigip.localhost.localdomain.ucs state: installed no_license: yes no_platform_check: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Install (upload, install) UCS using a passphrase necessary to load the UCS bigip_ucs: ucs: /root/bigip.localhost.localdomain.ucs state: installed passphrase: MyPassphrase1234 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove uploaded UCS file bigip_ucs: ucs: bigip.localhost.localdomain.ucs state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_firewall_policy – Manage AFM security firewall policies on a BIG-IP f5networks.f5\_modules.bigip\_firewall\_policy – Manage AFM security firewall policies on a BIG-IP ================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_policy`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages AFM (Advanced Firewall Manager) security firewall policies on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description to attach to the policy. This parameter is only supported on versions of BIG-IP >= 12.1.0. On earlier versions it is simply ignored. \| \| name string / required \| \| The name of the policy to create. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rules list / elements=string \| \| Specifies a list of rules you want associated with this policy. The order of this list is the order they will be evaluated by BIG-IP. If the specified rules do not exist (for example when creating a new policy), they will be created. Rules specified here, if they do not exist, will be created with "default deny" behavior. It is expected that you follow-up after this module with the actual configuration for these rules. The `bigip_firewall_rule` module can also be used to create and edit existing and new rules. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the policy exists. When `state` is `absent`, ensures the policy is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a basic policy with some rule stubs bigip_firewall_policy: name: foo rules: - rule1 - rule2 - rule3 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the policy. Sample: My firewall policy \| \| rules list / elements=string \| changed \| The list of rules, in the order that they are evaluated, on the device. Sample: ['rule1', 'rule2', 'rule3'] \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_partition – Manage BIG-IP partitions f5networks.f5\_modules.bigip\_partition – Manage BIG-IP partitions ================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_partition`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage partitions on the BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description to attach to the partition. \| \| name string / required \| \| Name of the partition. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| route\_domain integer \| \| The default Route Domain to assign to the partition. If no route domain is specified, the default route domain for the system (typically zero) will be used only when creating a new partition. \| \| state string \| Choices:* present ← * absent \| Whether the partition should exist or not. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create partition "foo" using the default route domain bigip_partition: name: foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create partition "bar" using a custom route domain bigip_partition: name: bar route_domain: 3 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Change route domain of partition "foo" bigip_partition: name: foo route_domain: 8 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set a description for partition "foo" bigip_partition: name: foo description: Tenant CompanyA provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Delete the "foo" partition bigip_partition: name: foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed and success \| The description of the partition. Sample: Example partition \| \| route\_domain integer \| changed and success \| Name of the route domain associated with the partition. \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_device_trust – Manage the trust relationships between BIG-IPs f5networks.f5\_modules.bigip\_device\_trust – Manage the trust relationships between BIG-IPs ============================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_trust`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the trust relationships between BIG-IP systems. Devices, once peered, cannot be updated. If updating is needed, the peer must first be removed before it can be re-added to the trust. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| peer\_hostname string \| \| The hostname you want to associate with the device. This value is used to easily distinguish this device in BIG-IP configuration. When trusting a new device, if this parameter is not specified, the value of `peer_server` is used as a default. \| \| peer\_password string \| \| The password of the API username of the remote peer device you are trusting. If this value is not specified, then the value of `password`, or the environment variable `F5_PASSWORD` is used. \| \| peer\_server string / required \| \| The peer address to connect to and trust for synchronizing the configuration. This is typically the management address of the remote device, but may also be a Self IP address. \| \| peer\_user string \| \| The API username of the remote peer device you are trusting. Note that the CLI user cannot be used unless it too has an API account. If this value is not specified, then the value of `user`, or the environment variable `F5_USER` is used. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* absent * present ← \| When `present`, ensures the specified devices are trusted. When `absent`, removes the device trusts. \| \| type string \| Choices:* peer ← * subordinate \| Specifies whether the device you are adding is a Peer or a Subordinate. The default is `peer`. The difference between the two is a matter of mitigating risk of compromise. A subordinate device cannot sign a certificate for another device. In the case where the security of an authority device in a trust domain is compromised, the risk of compromise is minimized for any subordinate device. Designating devices as subordinate devices is recommended for device groups with a large number of member devices, where the risk of compromise is high. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add trusts for all peer devices to Active device bigip_device_trust: peer_server: "{{ item.ansible_host }}" peer_hostname: "{{ item.inventory_hostname }}" peer_user: "{{ item.bigip_username }}" peer_password: "{{ item.bigip_password }}" provider: server: lb.mydomain.com user: admin password: secret loop: hostvars when: inventory_hostname in groups['master'] delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| peer\_hostname string \| changed \| The remote hostname used to identify the trusted peer. Sample: test-bigip-02.localhost.localdomain \| \| peer\_server string \| changed \| The remote IP address of the trusted peer. Sample: 10.0.2.15 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_ssl_ocsp – Manage OCSP configurations on BIG-IP f5networks.f5\_modules.bigip\_ssl\_ocsp – Manage OCSP configurations on BIG-IP ============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ssl_ocsp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OCSP configurations on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cache\_error\_timeout integer \| \| Specifies the lifetime of an error response in the cache, in seconds. \| \| cache\_timeout string \| \| Specifies the lifetime of the OCSP response in the cache, in seconds. \| \| certificate string \| \| Specifies a certificate used to sign an OCSP request. \| \| clock\_skew integer \| \| Specifies the tolerable absolute difference in the clocks of the responder and the BIG-IP system, in seconds. \| \| connection\_timeout integer \| \| Specifies the time interval the BIG-IP system waits for before ending the connection to the OCSP responder, in seconds. \| \| connections\_limit integer \| \| Specifies the maximum number of connections per second allowed for the OCSP certificate validator. \| \| dns\_resolver string \| \| Specifies the internal DNS resolver the BIG-IP system uses to fetch the OCSP response. This involves specifying one or more DNS servers in the DNS resolver configuration. Use this option when either there is a DNS server that can do the name-resolution of the OCSP responders, or the OCSP responder can be reached on one of BIG-IP system's interfaces. \| \| hash\_algorithm string \| Choices:* sha256 * sha1 \| Specifies a hash algorithm used to sign an OCSP request. \| \| key string \| \| Specifies a key used to sign an OCSP request. \| \| name string / required \| \| Specifies the name of the OCSP certificate validator. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| passphrase string \| \| Specifies a passphrase used to sign an OCSP request. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| proxy\_server\_pool string \| \| Specifies the proxy server pool the BIG-IP system uses to fetch the OCSP response. This involves creating a pool with proxy-servers. Use this option when either the OCSP responder cannot be reached on any of BIG-IP system's interfaces, or one or more servers can proxy an HTTP request to an external server and fetch the response. \| \| responder\_url string \| \| Specifies the absolute URL that overrides the OCSP responder URL obtained from the certificate's AIA extensions. This should be an HTTP-based URL. \| \| route\_domain string \| \| Specifies the route domain for fetching an OCSP response using HTTP forward proxy. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource does not exist. \| \| status\_age integer \| \| Specifies the maximum allowed lag time the BIG-IP system accepts for the 'thisUpdate' time in the OCSP response. \| \| strict\_responder\_checking boolean \| Choices:* no * yes \| Specifies whether the responder's certificate is checked for an OCSP signing extension. \| \| trusted\_responders string \| \| Specifies the certificates used for validating the OCSP response when the responder's certificate has been omitted from the response. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` allows the user to update passwords. `on_create` only sets the password for newly created OCSP validators. \| Notes ----- Note * Requires BIG-IP >= 13.x. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a OCSP validator bigip_ssl_ocsp: name: foo proxy_server_pool: validators-pool provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cache\_error\_timeout integer \| changed \| The new Response Caching Error Timeout value. Sample: 3600 \| \| cache\_timeout string \| changed \| The new Response Caching Timeout value. Sample: indefinite \| \| certificate string \| changed \| The new Request Signing Certificate value. Sample: /Common/cert1 \| \| clock\_skew integer \| changed \| The new Response Validation Clock Skew value. Sample: 300 \| \| connection\_timeout integer \| changed \| The new Connection Timeout value. Sample: 8 \| \| connections\_limit integer \| changed \| The new Concurrent Connections Limit value. Sample: 50 \| \| dns\_resolver string \| changed \| The new DNS Resolver value. Sample: /Common/resolver1 \| \| hash\_algorithm string \| changed \| The new Request Signing Hash Algorithm value. Sample: sha256 \| \| key string \| changed \| The new Request Signing Key value. Sample: /Common/key1 \| \| proxy\_server\_pool string \| changed \| The new Proxy Server Pool value. Sample: /Common/pool1 \| \| responder\_url string \| changed \| The new Connection Responder URL value. Sample: http://responder.site.com \| \| route\_domain string \| changed \| The new Route Domain value. Sample: /Common/0 \| \| status\_age integer \| changed \| The new Response Validation Status Age value. \| \| strict\_responder\_checking boolean \| changed \| The new Response Validation Strict Responder Certificate Checking value. Sample: True \| \| trusted\_responders integer \| changed \| The new Response Validation Trusted Responders value. Sample: /Common/default \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_message_routing_router – Manages router profiles for message-routing protocols f5networks.f5\_modules.bigip\_message\_routing\_router – Manages router profiles for message-routing protocols ============================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_message_routing_router`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages router profiles for message-routing protocols. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The user-defined description of the router profile. \| \| ignore\_client\_port boolean \| Choices:* no * yes \| When `yes`, the remote port on clientside connections (connections where the peer connected to the BIG-IP) is ignored when searching for an existing connection. \| \| inherited\_traffic\_group boolean \| Choices:* no * yes \| When set to `yes`, the `traffic_group` will be inherited from the containing folder. When not specified the system sets this to `no` when creating new router profile. \| \| max\_pending\_bytes integer \| \| The maximum number of bytes worth of pending messages that will be held while waiting for a connection to a peer to be created. Once reached, any additional messages to the peer will be flagged as undeliverable and returned to the originator. The accepted range is between 0 and 4294967295 inclusive. \| \| max\_pending\_messages integer \| \| The maximum number of pending messages that will be held while waiting for a connection to a peer to be created. Once reached, any additional messages to the peer will be flagged as undeliverable and returned to the originator. The accepted range is between 0 and 65535 inclusive. \| \| max\_retries integer \| \| Sets the maximum number of time a message may be resubmitted for rerouting by the `MR::retry` iRule command. The accepted range is between 0 and 4294967295 inclusive. \| \| mirror boolean \| Choices:* no * yes \| Enables or disables state mirroring. State mirroring can be used to maintain the same state information in the standby unit that is in the active unit. \| \| mirrored\_msg\_sweeper\_interval integer \| \| Specifies the maximum time in milliseconds that a message will be held on the standby device as it waits for the active device to route the message. Messages on the standby device held for longer than the configurable sweeper interval, will be dropped. The acceptable range is between 0 and 4294967295 inclusive. \| \| name string / required \| \| Specifies the name of the router profile. \| \| parent string \| \| The parent template of this router profile. Once this value has been set, it cannot be changed. The default values are set by the system if not specified and they correspond to the router type created, for example, `/Common/messagerouter` for `generic` `type` and so on. \| \| partition string \| Default:"Common" \| Device partition to create router profile on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| routes list / elements=string \| \| Specifies a list of static routes for the router instance to use. The route must be on the same partition as router profile. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the router profile exists. When `absent`, ensures the router profile is removed. \| \| traffic\_group string \| \| Specifies the traffic-group of the router profile. Setting the `traffic_group` to an empty string value `""` will cause the device to inherit from containing folder, which means the value of `inherited_traffic_group` on device will be `yes`. \| \| type string \| Choices:* generic ← \| Parameter used to specify the type of the router profile to manage. Default setting is `generic` with more options coming. \| \| use\_local\_connection boolean \| Choices:* no * yes \| If `yes`, the router will route a message to an existing connection on the same TMM as the message was received. \| Notes ----- Note * Requires BIG-IP >= 14.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a generic router profile bigip_message_routing_router: name: foo max_retries: 10 ignore_client_port: yes routes: - /Common/route1 - /Common/route2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify a generic router profile bigip_message_routing_router: name: foo ignore_client_port: no mirror: yes mirrored_msg_sweeper_interval: 4000 traffic_group: /Common/traffic-group-2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove a generic router profile bigip_message_routing_router: name: foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The user-defined description of the router profile. Sample: My description \| \| ignore\_client\_port boolean \| changed \| Enables ignoring of the remote port on clientside connections when searching for an existing connection. \| \| inherited\_traffic\_group boolean \| changed \| Specifies if a traffic-group should be inherited from containing folder. Sample: True \| \| max\_pending\_bytes integer \| changed \| The maximum number of bytes worth of pending messages that will be held. Sample: 10000 \| \| max\_pending\_messages integer \| changed \| The maximum number of pending messages that will be held. Sample: 64 \| \| max\_retries integer \| changed \| The maximum number of time a message may be resubmitted for rerouting. Sample: 10 \| \| mirror boolean \| changed \| Enables or disables state mirroring. Sample: True \| \| mirrored\_msg\_sweeper\_interval integer \| changed \| The maximum time in milliseconds that a message will be held on the standby device. Sample: 2000 \| \| parent string \| changed \| The parent template of this router profile. Sample: /Common/messagerouter \| \| routes list / elements=string \| changed \| The list of static routes for the router instance to use. Sample: ['/Common/route1', '/Common/route2'] \| \| traffic\_group string \| changed \| The traffic-group of the router profile. Sample: /Common/traffic-group-1 \| \| use\_local\_connection boolean \| changed \| Enables routing of messages to an existing connection on the same TMM as the message was received. Sample: True \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_profile_client_ssl – Manages client SSL profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_client\_ssl – Manages client SSL profiles on a BIG-IP ============================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_client_ssl`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages client SSL profiles on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| advertised\_cert\_authority string \| \| Specifies the CAs the system advertises to clients is being trusted by the profile. \| \| allow\_expired\_crl boolean \| Choices:* no * yes \| Instructs the system to use the specified CRL file even if it has expired. \| \| allow\_non\_ssl boolean \| Choices:* no * yes \| Enables or disables acceptance of non-SSL connections. When creating a new profile, the setting is provided by the parent profile. \| \| cache\_size integer added in 1.0.0 of f5networks.f5\_modules \| \| Specifies the number of sessions in the SSL session cache. The valid value range is between 0 and 4194304 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| cache\_timeout integer added in 1.0.0 of f5networks.f5\_modules \| \| Specifies the timeout value in seconds of the SSL session cache entries. Acceptable values are between 0 and 86400 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| cert\_auth\_depth integer \| \| Specifies the maximum number of certificates to be traversed in a client certificate chain. \| \| cert\_key\_chain list / elements=dictionary \| \| One or more certificates and keys to associate with the SSL profile. This option is always a list. The keys in the list dictate the details of the client/key/chain combination. Note that BIG-IPs can only have one of each type of each certificate/key type. This means you can only have one RSA, one DSA, and one ECDSA per profile. If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo, the device rejects it. This list is a complex list that specifies a number of keys. \| \| \| cert string / required \| \| Specifies a certificate name for use. \| \| \| chain string \| \| Contains a certificate chain relevant to the certificate and key mentioned previously. This key is optional. \| \| \| key string / required \| \| Contains a key name. \| \| \| passphrase string \| \| Contains the passphrase of the key file, if required. Passphrases are encrypted on the remote BIG-IP device. Therefore, there is no way to compare them when updating a client SSL profile. Due to this, if you specify a passphrase, this module will always register a `changed` event. \| \| \| true\_names boolean added in 1.1.0 of f5networks.f5\_modules \| Choices:* no ← * yes \| When `yes`, the module will not append `.crt` and `.key` extensions to the given certificate and key names. When `no`, the module will append `.crt` and `.key` extensions to the given certificate and key names. \| \| cipher\_group string added in 1.2.0 of f5networks.f5\_modules \| \| Specifies the cipher group to assign to this profile. When the `ciphers` parameter is in use, the `cipher_group` must be set to either `none` or `''`. When creating a new profile with `cipher_group`, if the parent profile has `ciphers` set by default, the `cipher` parameter must be set to `none` or `''` during creation. The parameter only works on TMOS version 13.x and later. \| \| ciphers string \| \| Specifies the list of ciphers the system supports. When the `cipher_group` parameter is in use, the `ciphers` parameter needs to be set to either `none` or `''`. \| \| client\_auth\_crl string \| \| Specifies the name of a file containing a list of revoked client certificates. \| \| client\_auth\_frequency string \| Choices:* once * always \| Specifies the frequency of client authentication for an SSL session. When `once`, specifies the system authenticates the client once for an SSL session. When `always`, specifies the system authenticates the client once for an SSL session and also upon reuse of that session. \| \| client\_certificate string \| Choices:* ignore * require * request \| Specifies the way the system handles client certificates. When `ignore`, specifies the system ignores certificates from client systems. When `require`, specifies the system requires a client to present a valid certificate. When `request`, specifies the system requests a valid certificate from a client but always authenticate the client. \| \| name string / required \| \| Specifies the name of the profile. \| \| options list / elements=string \| Choices:* netscape-reuse-cipher-change-bug * microsoft-big-sslv3-buffer * msie-sslv2-rsa-padding * ssleay-080-client-dh-bug * tls-d5-bug * tls-block-padding-bug * dont-insert-empty-fragments * no-ssl * no-dtls * no-session-resumption-on-renegotiation * no-tlsv1.1 * no-tlsv1.2 * no-tlsv1.3 * single-dh-use * ephemeral-rsa * cipher-server-preference * tls-rollback-bug * no-sslv2 * no-sslv3 * no-tls * no-tlsv1 * pkcs1-check-1 * pkcs1-check-2 * netscape-ca-dn-bug * netscape-demo-cipher-change-bug * none \| Options the system uses for SSL processing in the form of a list. When creating a new profile, the list is provided by the parent profile. When `''` or `none`, all options for SSL processing are disabled. \| \| parent string \| \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `clientssl` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| renegotiation boolean \| Choices:* no * yes \| Enables or disables SSL renegotiation. When creating a new profile, the setting is provided by the parent profile. \| \| retain\_certificate boolean \| Choices:* no * yes \| When `yes`, the client certificate is retained in SSL session. \| \| secure\_renegotiation string \| Choices:* require * require-strict * request \| Specifies the method of secure renegotiations for SSL connections. When creating a new profile, the setting is provided by the parent profile. When `request`, the system requests secure renegotiation of SSL connections. `require` is a default setting and when set, the system permits initial SSL handshakes from clients, but terminates renegotiations from unpatched clients. With the `require-strict` setting, the system requires strict renegotiation of SSL connections. In this mode, the system refuses connections to insecure servers, and terminates existing SSL connections to insecure servers. \| \| server\_name string \| \| Specifies the fully qualified DNS hostname of the server used in Server Name Indication communications. When creating a new profile, the setting is provided by the parent profile. The server name can also be a wildcard string containing the asterisk `` character. \| \| sni\_default* boolean \| Choices:* no * yes \| Indicates the system uses this profile as the default SSL profile when there is no match to the server name, or when the client provides no SNI extension support. When creating a new profile, the setting is provided by the parent profile. There can be only one SSL profile with this setting enabled. \| \| sni\_require boolean \| Choices:* no * yes \| Requires the network peers also provide SNI support. This setting only takes effect when `sni_default` is set to `true`. When creating a new profile, the setting is provided by the parent profile. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| strict\_resume boolean \| Choices:* no * yes \| Enables or disables the resumption of SSL sessions after an unclean shutdown. When creating a new profile, the setting is provided by the parent profile. \| \| trusted\_cert\_authority string \| \| Specifies a client CA the system trusts. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create client SSL profile bigip_profile_client_ssl: state: present name: my_profile provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create client SSL profile with specific ciphers bigip_profile_client_ssl: state: present name: my_profile ciphers: "!SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create client SSL profile with specific cipher group bigip_profile_client_ssl: state: present name: my_profile ciphers: "none" cipher_group: "/Common/f5-secure" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create client SSL profile with specific SSL options bigip_profile_client_ssl: state: present name: my_profile options: - no-sslv2 - no-sslv3 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create client SSL profile require secure renegotiation bigip_profile_client_ssl: state: present name: my_profile secure_renegotiation: request provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create a client SSL profile with a cert/key/chain setting bigip_profile_client_ssl: state: present name: my_profile cert_key_chain: - cert: bigip_ssl_cert1 key: bigip_ssl_key1 chain: bigip_ssl_cert1 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| allow\_non\_ssl boolean \| changed \| Acceptance of non-SSL connections. Sample: True \| \| cache\_size integer \| changed \| Specifies the number of sessions in the SSL session cache. Sample: 2000 \| \| cache\_timeout integer \| changed \| Specifies the timeout value in seconds of the SSL session cache entries. Sample: 1800 \| \| cipher\_group string \| changed \| The cipher group applied to the profile. Sample: /Common/f5-secure \| \| ciphers string \| changed \| The ciphers applied to the profile. Sample: !SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA \| \| options list / elements=string \| changed \| The list of options for SSL processing. Sample: ['no-sslv2', 'no-sslv3'] \| \| renegotiation boolean \| changed \| Renegotiation of SSL sessions. Sample: True \| \| secure\_renegotiation string \| changed \| The method of secure SSL renegotiation. Sample: request \| \| strict\_resume boolean \| changed \| Resumption of SSL sessions after an unclean shutdown. Sample: True \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_irule – Manage iRules across different modules on a BIG-IP f5networks.f5\_modules.bigip\_irule – Manage iRules across different modules on a BIG-IP ======================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_irule`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage iRules across different modules on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| content string \| \| When used instead of src, sets the contents of an iRule directly to the specified value. This is for simple values, but can be used with lookup plugins for anything complex or with formatting. Either one of `src` or `content` must be provided. \| \| module string / required \| Choices:* ltm * gtm \| The BIG-IP module to which the iRule should be added. \| \| name string / required \| \| The name of the iRule. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| src path \| \| The iRule file to interpret and upload to the BIG-IP. Either one of `src` or `content` must be provided. \| \| state string \| Choices:* present ← * absent \| Whether the iRule should exist or not. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add the iRule contained in template irule.tcl to the LTM module bigip_irule: content: "{{ lookup('template', 'irule.tcl') }}" module: ltm name: MyiRule state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add the iRule contained in static file irule.tcl to the LTM module bigip_irule: module: ltm name: MyiRule src: irule.tcl state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| content string \| changed and success \| The content of the iRule that was managed. Sample: when LB\_FAILED { set wipHost [LB::server addr] } \| \| module string \| changed and success \| The module that the iRule was added to. Sample: gtm \| \| src string \| changed and success, when provided \| The filename that included the iRule source. Sample: /opt/src/irules/example1.tcl \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_management_route – Manage system management routes on a BIG-IP f5networks.f5\_modules.bigip\_management\_route – Manage system management routes on a BIG-IP ============================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_management_route`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Configures route settings for the management interface of a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the management route. \| \| gateway string \| \| Specifies the system forwards packets to the destination through the gateway with the specified IP address. \| \| name string / required \| \| Specifies the name of the management route. \| \| network string \| \| The subnet and netmask for the route. To specify the route is the default route for the system, provide the value `default`. Only one `default` entry is allowed. This parameter cannot be changed after it is set. Therefore, if you do need to change it, you must delete it and create a new route. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a management route bigip_management_route: name: tacacs description: Route to TACACS gateway: 10.10.10.10 network: 11.11.11.0/24 state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the management route. Sample: Route to TACACS \| \| gateway string \| changed \| The new gateway of the management route. Sample: 10.10.10.10 \| \| network string \| changed \| The new network to use for the management route. Sample: default \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_message_routing_protocol – Manage the generic message parser profile. f5networks.f5\_modules.bigip\_message\_routing\_protocol – Manage the generic message parser profile. ===================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_message_routing_protocol`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages the generic message parser profile for use with the message routing framework. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The user-defined description of the generic parser profile. \| \| disable\_parser boolean \| Choices:* no * yes \| When `yes`, the generic message parser is disabled, ignoring all incoming packets and not directly send message data. This mode supports iRule script protocol implementations that generates messages from the incoming transport stream and sends outgoing messages on the outgoing transport stream. \| \| max\_egress\_buffer integer \| \| Specifies the maximum size of the send buffer in bytes. If the number of bytes in the send buffer for a connection exceeds this value, the generic message protocol will stop receiving outgoing messages from the router until the size of the size of the buffer drops below this setting. The accepted range is between 0 and 4294967295 inclusive. \| \| max\_msg\_size integer \| \| Specifies the maximum size of a received message. If a message exceeds this size, the connection will be reset. The accepted range is between 0 and 4294967295 inclusive. \| \| msg\_terminator string \| \| The string of characters used to terminate a message. If the message-terminator is not specified, the generic message parser will not separate the input stream into messages. \| \| name string / required \| \| Specifies the name of the generic parser profile. \| \| no\_response boolean \| Choices:* no * yes \| When set, matching of responses to requests is disabled. \| \| parent string \| \| The parent template of this parser profile. Once this value has been set, it cannot be changed. When creating a new profile, if this parameter is not specified, the default is the system-supplied `genericmsg` profile. \| \| partition string \| Default:"Common" \| Device partition to create route object on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the route exists. When `absent`, ensures the route is removed. \| Notes ----- Note * Requires BIG-IP >= 14.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a generic parser bigip_message_routing_protocol: name: foo description: 'This is parser' no_response: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify a generic parser bigip_message_routing_protocol: name: foo no_response: no max_egress_buffer: 10000 max_msg_size: 2000 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove generic parser bigip_message_routing_protocol: name: foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The user-defined description of the parser profile. Sample: My description \| \| disable\_parser boolean \| changed \| Disables generic message parser. Sample: True \| \| max\_egress\_buffer integer \| changed \| The maximum size of the send buffer in bytes. Sample: 10000 \| \| max\_msg\_size integer \| changed \| The maximum size of a received message. Sample: 4000 \| \| msg\_terminator string \| changed \| The string of characters used to terminate a message. Sample: %%%% \| \| no\_response boolean \| changed \| Disables matching of responses to requests. Sample: True \| \| parent string \| changed \| The parent template of this parser profile. Sample: /Common/genericmsg \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_device_group – Manage device groups on a BIG-IP f5networks.f5\_modules.bigip\_device\_group – Manage device groups on a BIG-IP ============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_group`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Managing device groups allows you to create HA pairs and clusters of BIG-IP devices. Usage of this module should be done in conjunction with the `bigip_configsync_actions` to sync the configuration across the pair or cluster if auto-sync is disabled. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auto\_sync boolean \| Choices:* no ← * yes \| Indicates whether configuration synchronization occurs manually or automatically. When creating a new device group, this option will default to `no`. \| \| description string \| \| Description of the device group. \| \| full\_sync boolean \| Choices:* no * yes \| Specifies whether the system synchronizes the entire configuration during synchronization operations. When `no`, the system performs incremental synchronization operations, based on the cache size specified in `max_incremental_sync_size`. Incremental configuration synchronization is a mechanism for synchronizing a device-group's configuration among its members, without requiring a full configuration load for each configuration change. In order for this to work, all devices in the device-group must initially agree on the configuration. Typically this requires at least one full configuration load to each device. When creating a new device group, this option will default to `no`. \| \| max\_incremental\_sync\_size integer \| \| Specifies the size of the changes cache for incremental sync. For example, using the default, if you make more than 1024 KB worth of incremental changes, the system performs a full synchronization operation. Using incremental synchronization operations can reduce the per-device sync/load time for configuration changes. This setting is relevant only when `full_sync` is `no`. \| \| name string / required \| \| Specifies the name of the device group. \| \| network\_failover boolean \| Choices:* no * yes \| Indicates whether failover occurs over the network or is hard-wired. This parameter is only valid for `type`s that are `sync-failover`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| save\_on\_auto\_sync boolean \| Choices:* no * yes \| When performing an auto-sync, specifies whether the configuration will be saved or not. When `no`, only the running configuration will be changed on the device(s) being synced to. When creating a new device group, this option will default to `no`. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the device group exists. When `state` is `absent`, ensures the device group is removed. \| \| type string \| Choices:* sync-failover * sync-only \| Specifies the type of group. A `sync-failover` device group contains devices that synchronize their configuration data and fail over to one another when a device becomes unavailable. A `sync-only` device group has no such failover. When creating a new device group, this option will default to `sync-only`. This setting cannot be changed once it has been set. \| Notes ----- Note * This module is primarily used as a component of configuring HA pairs of BIG-IP devices. * Requires BIG-IP >= 12.1.x. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a sync-only device group bigip_device_group: name: foo-group provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a sync-only device group with auto-sync enabled bigip_device_group: name: foo-group auto_sync: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| auto\_sync boolean \| changed \| The new auto\_sync value of the device group. Sample: True \| \| description string \| changed \| The new description of the device group. Sample: this is a device group \| \| full\_sync boolean \| changed \| The new full\_sync value of the device group. \| \| max\_incremental\_sync\_size integer \| changed \| The new sync size of the device group. Sample: 1000 \| \| network\_failover boolean \| changed \| Whether or not network failover is enabled. Sample: True \| \| save\_on\_auto\_sync boolean \| changed \| The new save\_on\_auto\_sync value of the device group. Sample: True \| \| type string \| changed \| The new type of the device group. Sample: sync-failover \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_ftp – Manage FTP monitors on a BIG-IP f5networks.f5\_modules.bigip\_monitor\_ftp – Manage FTP monitors on a BIG-IP ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_ftp`. New in version 1.1.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage FTP monitors on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| app\_service string \| \| The iApp service to be associated with this profile. When no service is specified, the default is None. \| \| debug boolean \| Choices:* no * yes \| Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. When `yes` the system redirects error messages and additional information to the `/var/log/monitors/<monitor_name>-<node_name>-<port>.log` file. \| \| description string \| \| The description of the monitor. \| \| filename string \| \| Specifies the full path and file name of the file the system attempts to download. The health check is successful if the system can download the file. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. This value must be less than the `timeout` value. When creating a new monitor, if this parameter is not provided, the default `5` will be used. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| manual\_resume* boolean \| Choices:* no * yes \| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to `yes`, you must manually re-enable the resource before the system can use it for load balancing connections. When creating a new monitor, if this parameter is not specified, the default value is `no`. When `yes`, specifies you must manually re-enable the resource after an unsuccessful monitor check. When `no`, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. \| \| mode string \| Choices:* passive * port \| Specifies the data transfer process (DTP) mode. When `passive`, the monitor sends a data transfer request to the FTP server. When the FTP server receives the request, the FTP server initiates and establishes the data connection. When `port`, the monitor initiates and establishes the data connection with the FTP server. \| \| name string / required \| \| Specifies the name of the monitor. \| \| parent string \| \| The parent template of this monitor template. Once this value has been set, it cannot be changed. When creating a new monitor, if this parameter is not specified, the default is the system-supplied `ftp` monitor. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must use a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password, if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name, if the monitored target requires authentication. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of `0` will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value will be `0`. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value will be `31`. \| \| up\_interval integer \| \| Specifies the interval at which the system performs the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. When creating a new monitor, if this parameter is not provided, the default `0` will be used. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will update passwords if the `target_password` is specified. `on_create` will only set the password for newly created monitors. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create FTP Monitor bigip_monitor_ftp: state: present ip: 10.10.10.10 name: my_ft_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove FTP Monitor bigip_monitor_ftp: state: absent name: my_ftp_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Include a username and password in the FTP monitor bigip_monitor_ftp: state: absent name: my_ftp_monitor target_username: monitor_user target_password: monitor_pass provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| app\_service string \| changed \| The iApp service associated with this monitor. Sample: /Common/good\_service.app/good\_service \| \| debug boolean \| changed \| Whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| filename string \| changed \| Specifies the full path and file name of the file the system attempts to download. Sample: /ftp/var/health.txt \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| manual\_resume boolean \| changed \| Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True \| \| mode string \| changed \| Specifies the data transfer process (DTP) mode. Sample: passive \| \| parent string \| changed \| The parent monitor. Sample: /Common/foo\_ftp \| \| port string \| changed \| Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Sample: 80 \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| up\_interval integer \| changed \| Interval for the system to use to perform the health check when a resource is up. \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_device_traffic_group – Manages traffic groups on BIG-IP f5networks.f5\_modules.bigip\_device\_traffic\_group – Manages traffic groups on BIG-IP ======================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_traffic_group`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Supports managing traffic groups and their attributes on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auto\_failback boolean \| Choices:* no * yes \| Specifies whether the traffic group fails back to the initial device specified in `ha_order`. \| \| auto\_failback\_time integer \| \| Specifies the number of seconds the system delays before failing back to the initial device specified in `ha_order`. The correct value range is `0 - 300` inclusive. \| \| ha\_group string \| \| Specifies a configured `HA group` to be associated with the traffic group. Once you create an HA group on a device and associate the HA group with a traffic group, you must create an HA group and associate it with that same traffic group on every device in the device group. To disable an HA group failover method, specify an empty string value (`""`) to this parameter. Disabling an HA group will revert the device back to using `Load Aware` method (the default), unless `ha_order` setting is also configured. The `auto_failback` and `auto_failback_time` are not compatible with `ha_group`. \| \| ha\_load\_factor integer \| \| The value of the load the traffic-group presents the system relative to other traffic groups. This parameter only takes effect when `Load Aware` failover method is in use. The correct value range is `1 - 1000` inclusive. \| \| ha\_order list / elements=string \| \| Specifies the order in which you would like to assign devices for failover. If you configure this setting, you must configure the setting on every traffic group in the device group. The values should be device names of the devices that belong to the failover group configured previously. The order in which the devices are placed as arguments to this parameter determines their HA order on the device. Meaning that changing the order of the same elements will cause a change on the unit. To disable an HA order failover method, specify an empty string value (`""`) to this parameter. Disabling an HA order will revert the device back to using the Load Aware method (the default), unless the `ha_group` setting is also configured. Device names will be prepended with a partition by the module, so you can provide either the full path format name `/Common/bigip1` or just the name string `bigip1`. \| \| mac\_address string \| \| Specifies the floating Media Access Control (MAC) address associated with the floating IP addresses defined for a traffic group. Primarily, a MAC masquerade address minimizes ARP communications or dropped packets as a result of failover. A MAC masquerade address ensures any traffic destined for a specific traffic group reaches an available device after failover, which happens because, along with the traffic group, the MAC masquerade address floats to the available device. Without a MAC masquerade address, the sending host must learn the MAC address for a newly-active device, either by sending an ARP request or by relying on the gratuitous ARP from the newly-active device. To unset the MAC address, specify an empty value (`""`) to this parameter. \| \| name string / required \| \| The name of the traffic group. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the traffic group exists. When `absent`, ensures the traffic group is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a traffic group bigip_device_traffic_group: name: foo1 state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Create a traffic group with ha_group failover bigip_device_traffic_group: name: foo2 state: present ha_group: foo_HA_grp provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Create a traffic group with ha_order failover bigip_device_traffic_group: name: foo3 state: present ha_order: - /Common/bigip1.lab.local - /Common/bigip2.lab.local auto_failback: yes auto_failback_time: 40 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Change traffic group ha_order to ha_group bigip_device_traffic_group: name: foo3 state: present ha_group: foo_HA_grp ha_order: "" auto_failback: no provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove traffic group bigip_device_traffic_group: name: foo state: absent provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| auto\_failback boolean \| changed \| Specifies whether the traffic group fails back to the initial device specified in ha\_order. Sample: True \| \| auto\_failback\_time integer \| changed \| Specifies the number of seconds the system delays before failing back. Sample: 60 \| \| ha\_group string \| changed \| The configured HA group associated with traffic group. Sample: foo\_HA\_grp \| \| ha\_load\_factor integer \| changed \| The value of the load the traffic-group presents the system relative to other traffic groups. Sample: 20 \| \| ha\_order list / elements=string \| changed \| Specifies the order in which the devices will failover. Sample: ['/Common/bigip1', '/Common/bigip2'] \| \| mac\_address string \| changed \| The MAC masquerade address Sample: 02:01:d7:93:35:08 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_profile_persistence_cookie – Manage cookie persistence profiles on BIG-IP f5networks.f5\_modules.bigip\_profile\_persistence\_cookie – Manage cookie persistence profiles on BIG-IP ========================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_persistence_cookie`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage cookie persistence profiles on BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| always\_send boolean \| Choices:* no * yes \| Sends the cookie persistence entry on every reply, even if the entry has previously been supplied to the client. \| \| cookie\_encryption string \| Choices:* disabled * preferred * required \| Specifies the way in which the cookie encryption format is used. When `disabled`, generates the cookie format unencrypted. When `preferred`, generates an encrypted cookie, but accepts both encrypted and unencrypted formats. When `required`, cookie format must be encrypted. \| \| cookie\_method string \| Choices:* hash * insert * passive * rewrite \| Specifies the type of cookie processing the system uses. When `hash`, specifies the server provides the cookie, which the system then maps consistently to a specific node. This persistence type requires a `cookie_name` value. When `insert`, specifies the system inserts server information, in the form of a cookie, into the header of the server response. When `passive`, specifies the server provides the cookie, formatted with the correct server information and timeout. This persistence type requires a `cookie_name` value. When `rewrite`, specifies the system intercepts the BIGipCookie header, sent from the server, and overwrites the name and value of that cookie. \| \| cookie\_name string \| \| Specifies a unique name for the cookie. \| \| description string \| \| Description of the profile. \| \| encrypt\_cookie\_pool\_name boolean \| Choices:* no * yes \| Specifies whether the pool-name in the inserted BIG-IP default cookie should be encrypted. \| \| encryption\_passphrase string \| \| Specifies a passphrase to be used for cookie encryption. \| \| expiration dictionary \| \| Specifies the expiration time of the cookie. By default the system generates and uses a session cookie. This cookie expires when the user session expires (when the browser is closed). \| \| \| days integer \| \| Cookie expiration time in days. The value must be in range from `0` to `24855` days. \| \| \| hours integer \| \| Cookie expiration time in hours. The value must be in the range from `0` to `23` hours. \| \| \| minutes integer \| \| Cookie expiration time in minutes. The value must be in the range from `0` to `59` minutes. \| \| \| seconds integer \| Default:0 \| Cookie expiration time in seconds. The value must be in the range from `0` to `59` seconds. \| \| http\_only boolean \| Choices:* no * yes \| Specifies whether the httponly attribute should be enabled or disabled for the inserted cookies. \| \| match\_across\_pools boolean \| Choices:* no * yes \| When `yes`, specifies the system can use any pool that contains this persistence record. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| match\_across\_services boolean \| Choices:* no * yes \| When `yes`, specifies all persistent connections from a client IP address that go to the same virtual IP address also go to the same node. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| match\_across\_virtuals boolean \| Choices:* no * yes \| When `yes`, specifies all persistent connections from the same client IP address go to the same node. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| name string / required \| \| Specifies the name of the profile. \| \| override\_connection\_limit boolean \| Choices:* no * yes \| When `yes`, specifies the system allows you to specify that pool member connection limits will be overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden. \| \| parent string \| Default:"cookie" \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `cookie` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| secure boolean \| Choices:* no * yes \| Specifies whether the secure attribute should be enabled or disabled for the inserted cookies. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will allow updating passphrases if the user chooses to do so. `on_create` will only set the passphrase for newly created profiles. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a persistence cookie profile bigip_profile_persistence_cookie: name: foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a persistence cookie profile with expiration time bigip_profile_persistence_cookie: name: foo expiration: days: 7 hours: 12 minutes: 30 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| always\_send boolean \| changed \| The new Always Send value. \| \| cookie\_encryption string \| changed \| The new Cookie Encryption type. Sample: preferred \| \| cookie\_method string \| changed \| The new Cookie Method. Sample: insert \| \| cookie\_name string \| changed \| The new Cookie Name value. Sample: cookie1 \| \| description string \| changed \| The new description. Sample: My description \| \| encrypt\_cookie\_pool\_name boolean \| changed \| The new Encrypt Cookie Pool Name value. Sample: True \| \| expiration complex \| changed \| The expiration time of the cookie. Sample: hash/dictionary of values \| \| \| days integer \| changed \| Cookie expiration time in days. Sample: 125 \| \| \| hours integer \| changed \| Cookie expiration time in hours. Sample: 22 \| \| \| minutes integer \| changed \| Cookie expiration time in minutes. Sample: 58 \| \| \| seconds integer \| changed \| Cookie expiration time in seconds. Sample: 20 \| \| http\_only boolean \| changed \| The new HTTP Only value. Sample: True \| \| match\_across\_pools boolean \| changed \| The new Match Across Pools value. Sample: True \| \| match\_across\_services boolean \| changed \| The new Match Across Services value. \| \| match\_across\_virtuals boolean \| changed \| The new Match Across Virtuals value. Sample: True \| \| override\_connection\_limit boolean \| changed \| The new Override Connection Limit value. \| \| parent string \| changed \| The parent profile. Sample: /Common/cookie \| \| secure boolean \| changed \| The new Secure Cookie value. \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_dns_cache_resolver – Manage DNS resolver cache configuration on a BIG-IP f5networks.f5\_modules.bigip\_dns\_cache\_resolver – Manage DNS resolver cache configuration on a BIG-IP ======================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_dns_cache_resolver`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the DNS resolver cache configuration on BIG-IP devices. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| answer\_default\_zones boolean \| Choices:* no * yes \| Specifies whether the system answers DNS queries for the default zones localhost, reverse 127.0.0.1 and ::1, and AS112. When creating a new cache resolver, if this parameter is not specified, the default is `no`. \| \| forward\_zones raw \| \| Forward zones associated with the cache. To remove all forward zones, specify a value of `none`. \| \| \| name string \| \| Specifies an FQDN for the forward zone. \| \| \| nameservers list / elements=dictionary \| \| Specifies the IP address and service port of a recursive nameserver that answers DNS queries for the zone when the response cannot be found in the DNS cache. \| \| \| \| address string \| \| Address of recursive nameserver. \| \| \| \| port integer \| \| Port of recursive nameserver. When specifying new nameservers, if this value is not provided, the default is `53`. \| \| name string / required \| \| Specifies the name of the cache. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| route\_domain string \| \| Specifies the route domain the resolver uses for outbound traffic. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a DNS resolver cache bigip_dns_cache: name: foo answer_default_zones: yes forward_zones: - name: foo.bar.com nameservers: - address: 1.2.3.4 port: 53 - address: 5.6.7.8 route_domain: 0 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| param1 boolean \| changed \| The new param1 value of the resource. Sample: True \| \| param2 string \| changed \| The new param2 value of the resource. Sample: Foo is bar \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_gtm_monitor_tcp – Manages F5 BIG-IP GTM TCP monitors f5networks.f5\_modules.bigip\_gtm\_monitor\_tcp – Manages F5 BIG-IP GTM TCP monitors ==================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_monitor_tcp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP GTM (now BIG-IP DNS) TCP monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| ignore\_down\_response boolean \| Choices:* no * yes \| Specifies the monitor allows more than one probe attempt per interval. When `yes`, specifies the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down. When `no`, specifies the monitor immediately marks an object down when it receives a down response. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value will be 30. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. If this value is an IP address, a `port` number must be specified. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/tcp" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `tcp` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. Note that if using an IP address, you must specify a value between 1 and 65535. \| \| probe\_timeout* integer \| \| Specifies the number of seconds after which the system times out the probe request to the system. When creating a new monitor, if this parameter is not provided, then the default value will be `5`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| receive string \| \| The receive string for the monitor call. \| \| reverse boolean \| Choices:* no * yes \| Instructs the system to mark the target resource down when the test is successful. This setting is useful, for example, if the content on your web site home page is dynamic and changes frequently, you may want to set up a reverse ECV service check that looks for the string Error. A match for this string means the web server was down. To use this option, you must specify values for `send` and `receive`. \| \| send string \| \| The send string for the monitor call. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value will be 120. \| \| transparent boolean \| Choices:* no * yes \| Specifies whether the monitor operates in transparent mode. A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the `ip`-`port` combination specified in the monitor). If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down. When creating a new monitor, if this parameter is not provided, then the default value will be `no`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a GTM TCP monitor bigip_gtm_monitor_tcp: name: my_monitor ip: 1.1.1.1 port: 80 send: my send string receive: my receive string state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove TCP Monitor bigip_gtm_monitor_tcp: name: my_monitor state: absent provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add TCP monitor for all addresses, port 514 bigip_gtm_monitor_tcp: name: my_monitor port: 514 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| ignore\_down\_response boolean \| changed \| Whether to ignore the down response or not. Sample: True \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: tcp \| \| port string \| changed \| The new port on which the monitor checks the resource. Sample: 8080 \| \| probe\_timeout integer \| changed \| The new timeout in which the system will timeout the monitor probe. Sample: 10 \| \| receive string \| changed \| The new receive string for this monitor. Sample: tcp string to receive \| \| reverse boolean \| changed \| The new value for whether the monitor operates in reverse mode. \| \| send string \| changed \| The new send string for this monitor. Sample: tcp string to send \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| transparent boolean \| changed \| The new value for whether the monitor operates in transparent mode. \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_device_auth – Manage system authentication on a BIG-IP f5networks.f5\_modules.bigip\_device\_auth – Manage system authentication on a BIG-IP ===================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_auth`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the system authentication configuration. This module can assist in configuring a number of different system authentication types. Note that this module can not be used to configure APM authentication types. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accounting string \| Choices:* send-to-first-server * send-to-all-servers \| Specifies how the system returns accounting information, such as which services users access and the amount of network resources they consume, to the TACACS+ server. When `send-to-first-server`, specifies the system transmits accounting information back to the first available TACACS+ server in the list. When `send-to-all-servers`, specifies the system transmits accounting information back to all TACACS+ servers in the list. This parameter is supported by the `tacacs` type. \| \| authentication string \| Choices:* use-first-server * use-all-servers \| Specifies the process the system employs when sending authentication requests. When `use-first-server`, specifies the system sends authentication attempts only to the first server in the list. When `use-all-servers`, specifies the system sends an authentication request to each server until authentication succeeds, or until the system has sent a request to all servers in the list. This parameter is supported by the `tacacs` type. \| \| protocol\_name string \| Choices:* lcp * ip * ipx * atalk * vines * lat * xremote * tn3270 * telnet * rlogin * pad * vpdn * ftp * http * deccp * osicp * unknown \| Specifies the protocol associated with the value specified in `service_name`, which is a subset of the associated service being used for client authorization or system accounting. Note that the majority of TACACS+ implementations are of protocol type `ip`, so try that first. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| secret string \| \| Secret key used to encrypt and decrypt packets sent or received from the server. Do not use the pound/hash sign in the secret for TACACS+ servers. When configuring TACACS+ auth for the first time, this value is required. \| \| servers raw \| \| Specifies a list of the IPv4 addresses for servers using the Terminal Access Controller Access System (TACACS)+ protocol with which the system communicates to obtain authorization data. For each address, an alternate TCP port number may be optionally specified by specifying the `port` key. If no port number is specified, the default port `49163` is used. This parameter is supported by the `tacacs` type. \| \| \| address string \| \| The IP address of the server. This field is required, unless you are specifying a simple list of servers. In that case, the simple list can specify server IPs. See the examples for more clarification. \| \| \| port string \| \| The port of the server. \| \| service\_name string \| Choices:* slip * ppp * arap * shell * tty-daemon * connection * system * firewall \| Specifies the name of the service the user is requesting to be authorized to use. Identifying what the user is asking to be authorized for enables the TACACS+ serverc to behave differently for different types of authorization requests. This setting is required when configuring this form of system authentication. Note that the majority of TACACS+ implementations are of service type `ppp`, so try that first. \| \| state string \| Choices:* absent * present ← \| The state of the authentication configuration on the system. When `present`, guarantees the system is configured for the specified `type`. When `absent`, sets the system auth source back to `local`. \| \| type string / required \| Choices:* tacacs * local \| The authentication type to manage with this module. Take special note that the parameters supported by this module will vary depending on the `type` that you are configuring. At this time, this module only supports a subset of the total available auth types. \| \| update\_secret string \| Choices:* always ← * on\_create \| `always` will allow updating secrets if the user chooses to do so. `on_create` will only set the secret when a `use_auth_source` is `yes` and TACACS+ is not currently the auth source. \| \| use\_for\_auth boolean \| Choices:* no * yes \| Specifies whether or not this auth source is put in use on the system. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set the system auth to TACACS+, default server port bigip_device_auth: type: tacacs authentication: use-all-servers accounting: send-to-all-servers protocol_name: ip secret: secret servers: - 10.10.10.10 - 10.10.10.11 service_name: ppp state: present use_for_auth: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set the system auth to TACACS+, override server port bigip_device_auth: type: tacacs authentication: use-all-servers protocol_name: ip secret: secret servers: - address: 10.10.10.10 port: 1234 - 10.10.10.11 service_name: ppp use_for_auth: yes state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| accounting string \| changed \| Which servers to send information to when using TACACS. Sample: send-to-all-servers \| \| authentication string \| changed \| Process the system uses to serve authentication requests when using TACACS. Sample: use-all-servers \| \| protocol\_name string \| changed \| Name of the protocol associated with `service_name` used for client authentication. Sample: ip \| \| servers list / elements=string \| changed \| List of servers used in TACACS authentication. Sample: ['1.2.2.1', '4.5.5.4'] \| \| service\_name string \| changed \| Name of the service the user is requesting to be authorized to use. Sample: ppp \| ### Authors * Tim Rupp (@caphrim007) * Nitin Khanna (@nitinthewiz) ansible f5networks.f5_modules.bigiq_application_http – Manages BIG-IQ HTTP applications f5networks.f5\_modules.bigiq\_application\_http – Manages BIG-IQ HTTP applications ================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_application_http`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IQ applications used for load balancing an HTTP application on port 80 on BIG-IP systems. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| add\_analytics boolean \| Choices:* no ← * yes \| Collects statistics of the BIG-IP to which the application is deployed. This parameter is only relevant when specifying a `service_environment` which is a BIG-IP; not an SSG. \| \| description string \| \| Description of the application. \| \| inbound\_virtual dictionary \| \| Settings to configure the virtual which receives the inbound connection. This virtual is used to host the HTTP endpoint of the application. \| \| \| address string / required \| \| Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. \| \| \| netmask string / required \| \| Specifies the netmask to associate with the given `destination`. This parameter is required when creating a new application. \| \| \| port string \| Default:80 \| The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is `80`. \| \| name string / required \| \| Name of the new application. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| servers list / elements=dictionary \| \| A list of servers on which the application is hosted. If you are familiar with other BIG-IP settings, you might also refer to this list as the list of pool members. When creating a new application, at least one server is required. \| \| \| address string / required \| \| The IP address of the server. \| \| \| port string \| Default:80 \| The port of the server. When creating a new application and specifying a server, if this parameter is not provided, the default is `80`. \| \| service\_environment string \| \| Specifies the name of service environment to which the application is deployed. When creating a new application, this parameter is required. The service environment type is automatically discovered by this module. Therefore, it is crucial that you maintain unique names for items in the different service environment types (at this time, SSGs and BIG-IPs). \| \| state string \| Choices:* absent * present ← \| The state of the resource on the system. When `present`, guarantees the resource exists with the provided attributes. When `absent`, removes the resource from the system. \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the application to be created, deleted, or updated. \| Notes ----- Note * This module does not support updating of your application (whether deployed or not). If you need to update the application, we recommend removing and recreating it. * This module will not work on BIG-IQ version 6.1.x or greater. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Load balance an HTTP application on port 80 on BIG-IP bigiq_application_http: name: my-app description: Redirect HTTP to HTTPS service_environment: my-ssg servers: - address: 1.2.3.4 port: 8080 - address: 5.6.7.8 port: 8080 inbound_virtual: name: foo address: 2.2.2.2 netmask: 255.255.255.255 port: 443 provider: password: secret server: lb.mydomain.com user: admin state: present delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the application of the resource. Sample: My application \| \| inbound\_virtual\_destination string \| changed \| The destination of the virtual that was created. Sample: 6.7.8.9 \| \| inbound\_virtual\_netmask string \| changed \| The network mask of the provided inbound destination. Sample: 255.255.255.0 \| \| inbound\_virtual\_port integer \| changed \| The port on which the inbound virtual address listens. Sample: 80 \| \| servers complex \| changed \| List of servers, and their ports, that make up the application. Sample: hash/dictionary of values \| \| \| address string \| changed \| The IP address of the server. Sample: 2.3.4.5 \| \| \| port integer \| changed \| The port on which the server listens. Sample: 8080 \| \| service\_environment string \| changed \| The environment to which the service was deployed. Sample: my-ssg1 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_timer_policy – Manage timer policies on a BIG-IP f5networks.f5\_modules.bigip\_timer\_policy – Manage timer policies on a BIG-IP =============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_timer_policy`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage timer policies on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Specifies descriptive text that identifies the timer policy. \| \| name string / required \| \| Specifies the name of the timer policy. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rules list / elements=dictionary \| \| Rules you want assigned to the timer policy. \| \| \| destination\_ports list / elements=string \| \| The list of destination ports on which to match the rule. Specify a port range by specifying start and end ports separated by a dash (-). This field is only available if you have selected the `sctp`, `tcp`, or `udp` protocol. \| \| \| idle\_timeout string \| Default:"unspecified" \| Specifies an idle timeout, in seconds, for protocol and port pairs that match the timer policy rule. When `infinite`, specifies the protocol and port pairs that match the timer policy rule have no idle timeout. When specifying rules, if this parameter is not specified, the default is `unspecified`. \| \| \| name string / required \| \| The name of the rule. \| \| \| protocol string \| Choices:* all-other ← * ah * bna * esp * etherip * gre * icmp * ipencap * ipv6 * ipv6-auth * ipv6-crypt * ipv6-icmp * isp-ip * mux * ospf * sctp * tcp * udp * udplite \| Specifies the IP protocol entry for which the timer policy rule is being configured. This could be a layer-4 protocol (such as `tcp`, `udp` or `sctp`. Only flows matching the configured protocol will make use of this rule. When `all-other` is specified, if there are no specific ip-protocol rules that match the flow, the flow matches all the other ip-protocol rules. When specifying rules, if this parameter is not specified, the default is `all-other`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a timer policy bigip_timer_policy: name: timer1 description: My timer policy rules: - name: rule1 protocol: tcp idle_timeout: indefinite destination_ports: - 443 - 80 - name: rule2 protocol: 200 - name: rule3 protocol: sctp idle_timeout: 200 destination_ports: - 21 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove a timer policy and all its associated rules bigip_timer_policy: name: timer1 description: My timer policy state: absent provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the timer policy. Sample: True \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_gateway_icmp – Manages F5 BIG-IP LTM gateway ICMP monitors f5networks.f5\_modules.bigip\_monitor\_gateway\_icmp – Manages F5 BIG-IP LTM gateway ICMP monitors ================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_gateway_icmp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages gateway ICMP monitors on a BIG-IP LTM. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adaptive boolean \| Choices:* no * yes \| Specifies whether adaptive response time monitoring is enabled for this monitor. When `yes`, the monitor determines the state of a service based on how divergent from the mean latency a monitor probe for that service is allowed to be. Also, values for the `allowed_divergence`, `adaptive_limit`, and and `sampling_timespan` will be enforced. When `disabled`, the monitor determines the state of a service based on the `interval`, `up_interval`, `time_until_up`, and `timeout` monitor settings. \| \| adaptive\_limit integer \| \| Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of `allowed_divergence` setting, for a probe to be considered successful. This value applies regardless of the value of the `allowed_divergence` setting. While this value can be configured when `adaptive` is `no`, it will not take effect on the system until `adaptive` is `yes`. \| \| allowed\_divergence\_type string \| Choices:* relative * absolute \| When specifying a new monitor, if `adaptive` is `yes`, the default is `relative`. When `absolute`, the number of milliseconds the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. In typical cases, if the monitor detects three probes in a row that miss the latency value you set, the pool member or node is marked down. When `relative`, the percentage of deviation the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. \| \| allowed\_divergence\_value integer \| \| When specifying a new monitor, if `adaptive` is `yes`, and `type` is `relative`, the default is `25` percent. \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| manual\_resume* boolean \| Choices:* no * yes \| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to `yes`, you must manually re-enable the resource before the system can use it for load balancing connections. When `yes`, specifies you must manually re-enable the resource after an unsuccessful monitor check. When `no`, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. \| \| name string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/gateway\_icmp" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `gateway_icmp` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must use a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| sampling\_timespan integer \| \| Specifies the length, in seconds, of the probe history window that the system uses to calculate the mean latency and standard deviation of a monitor probe. While this value can be configured when `adaptive` is `no`, it will not take effect on the system until `adaptive` is `yes`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures that the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked 'up'. A value of `0` means the resource is marked up immediately upon receipt of the first correct response. \| \| timeout integer \| \| Specifies the number of seconds the target has in which to respond to the monitor request. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that `timeout` and `time_until_up` combine to control when a resource is set to up. \| \| transparent boolean \| Choices:* no * yes \| Specifies whether the monitor operates in transparent mode. A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the `ip`-`port` combination specified in the monitor). If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down. When creating a new monitor, if this parameter is not provided, then the default value will be whatever is provided by the `parent`. \| \| up\_interval integer \| \| Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a monitor bigip_monitor_gateway_icmp: name: gw1 adaptive: no interval: 1 time_until_up: 0 timeout: 3 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| adaptive boolean \| changed \| Whether adaptive is enabled or not. Sample: True \| \| adaptive\_limit integer \| changed \| Absolute number of milliseconds that may not be exceeded by a monitor probe. Sample: 200 \| \| allowed\_divergence\_type string \| changed \| Type of divergence used for adaptive response time monitoring. Sample: absolute \| \| allowed\_divergence\_value integer \| changed \| Value of the type of divergence used for adaptive response time monitoring. May be `percent` or `ms` depending on whether `relative` or `absolute`. Sample: 25 \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: gateway-icmp \| \| port string \| changed \| Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Sample: 80 \| \| sampling\_timespan integer \| changed \| Absolute number of milliseconds that may not be exceeded by a monitor probe. Sample: 200 \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| transparent boolean \| changed \| Whether the monitor operates in transparent mode. \| \| up\_interval integer \| changed \| Interval for the system to use to perform the health check when a resource is up. \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_software_update – Manage the software update settings of a BIG-IP f5networks.f5\_modules.bigip\_software\_update – Manage the software update settings of a BIG-IP ================================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_software_update`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the software update settings of a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auto\_check boolean \| Choices:* no * yes \| Specifies whether to automatically check for updates on the F5 Networks downloads server. \| \| auto\_phone\_home boolean \| Choices:* no * yes \| Specifies whether to automatically send phone home data to the F5 Networks PhoneHome server. \| \| frequency string \| Choices:* daily * monthly * weekly \| Specifies the schedule for the automatic update check. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Enable automatic update checking bigip_software_update: auto_check: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Disable automatic update checking and phoning home bigip_software_update: auto_check: no auto_phone_home: no provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| auto\_check boolean \| changed \| Whether the system automatically checks for updates. Sample: True \| \| auto\_phone\_home boolean \| changed \| Whether the system automatically sends phone home data. Sample: True \| \| frequency string \| changed \| Frequency of auto update checks. Sample: weekly \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_sys_db – Manage BIG-IP system database variables f5networks.f5\_modules.bigip\_sys\_db – Manage BIG-IP system database variables =============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_sys_db`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP system database variables. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| key string / required \| \| The database variable to manipulate. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * reset \| The state of the variable on the system. When `present`, guarantees an existing variable is set to `value`. When `reset`, sets the variable back to the default value. At least one of value and state `reset` are required. \| \| value string \| \| The value to set the key to. At least one of value and state `reset` are required. \| Notes ----- Note * Requires BIG-IP version 12.0.0 or later. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set the boot.quiet DB variable on the BIG-IP bigip_sys_db: key: boot.quiet value: disable provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Disable the initial setup screen bigip_sys_db: key: setup.run value: false provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Reset the initial setup screen bigip_sys_db: key: setup.run state: reset provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| default\_value string \| changed and success \| The default value of the key. Sample: True \| \| name string \| changed and success \| The key in the system database. Sample: setup.run \| \| value string \| changed and success \| The value that you set the key to. \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_device_auth_ldap – Manage LDAP device authentication settings on BIG-IP f5networks.f5\_modules.bigip\_device\_auth\_ldap – Manage LDAP device authentication settings on BIG-IP ======================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_auth_ldap`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage LDAP device authentication settings on BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bind\_dn string \| \| Specifies the distinguished name for the Active Directory or LDAP server user ID. The BIG-IP client authentication module does not support Active Directory or LDAP servers that do not perform bind referral when authenticating referred accounts. Therefore, if you plan to use Active Directory or LDAP as your authentication source and want to use referred accounts, make sure your servers perform bind referral. \| \| bind\_password string \| \| Specifies a password for the Active Directory or LDAP server user ID. \| \| ca\_cert string \| \| Specifies the name of an SSL certificate from a certificate authority (CA). To remove this value, use the reserved value `none`. aliases: ssl\_ca\_cert \| \| check\_member\_attr boolean \| Choices:* no * yes \| Checks the member attribute of the user in the remote LDAP or AD group. \| \| client\_cert string \| \| Specifies the name of an SSL client certificate. To remove this value, use the reserved value `none`. aliases: ssl\_client\_cert \| \| client\_key string \| \| Specifies the name of an SSL client key. To remove this value, use the reserved value `none`. aliases: ssl\_client\_key \| \| fallback\_to\_local boolean \| Choices:* no * yes \| Specifies the system uses the Local authentication method if the remote authentication method is not available. Option only available on `TMOS 13.0.0` and above. \| \| login\_ldap\_attr string \| \| Specifies the LDAP directory attribute containing the local user name that is associated with the selected directory entry. If this parameter is not specified, when configuring LDAP device authentication for the first time, the default port is `samaccountname`. \| \| port integer \| \| Specifies the port the system uses for access to the remote host server. When configuring LDAP device authentication for the first time, the default port is `389` if this parameter is not specified. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| remote\_directory\_tree string \| \| Specifies the file location (tree) of the user authentication database on the server. \| \| scope string \| Choices:* sub * one * base \| Specifies the level of the remote Active Directory or LDAP directory the system should search for the user authentication. \| \| servers list / elements=string \| \| Specifies the LDAP servers the system must use to obtain authentication information. You must specify a server when you create an LDAP configuration object. \| \| ssl string \| Choices:* yes * no * start-tls \| Specifies whether the system uses an SSL port to communicate with the LDAP server. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the device authentication method exists. When `absent`, ensures the device authentication method does not exist. When `state` equal to (absent), before you can delete the LDAP configuration, the system must set auth to some alternative. The system ships with a system auth called `local`, therefore the system authentication type will be set to that value on the device upon removal of LDAP configuration. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will always update the `bind_password`. `on_create` will only set the `bind_password` for newly created authentication mechanisms. \| \| use\_for\_auth boolean \| Choices:* no * yes \| Specifies whether or not this auth source is put in use on the system. If `yes`, the module sets the current system auth type to the value of `ldap`. If `no`, the module sets the authentication type to `local`, similar behavior to when `state` is `absent`, without removing the configured LDAP resource. \| \| user\_template string \| \| Specifies the distinguished name of the user who is logging on. You specify the template as a variable that the system replaces with user-specific information during the logon attempt. For example, you could specify a user template such as `%[email protected]` or `uxml:id=%s,ou=people,dc=siterequest,dc=com`. When a user attempts to log on, the system replaces `%s` with the name the user specified in the Basic Authentication dialog box, and passes that as the distinguished name for the bind operation. The system passes the associated password as the password for the bind operation. This field can contain only one `%s` and cannot contain any other format specifiers. \| \| validate\_certs boolean \| Choices:* no * yes \| Specifies whether the system checks an SSL peer, as a result of which the system requires and verifies the server certificate. aliases: ssl\_check\_peer \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an LDAP authentication object bigip_device_auth_ldap: name: foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| bind\_dn string \| changed \| The distinguished name for the Active Directory or LDAP server user ID. Sample: [email protected] \| \| ca\_cert string \| changed \| The name of an SSL certificate from a certificate authority. Sample: My-Trusted-CA-Bundle.crt \| \| check\_member\_attr boolean \| changed \| The user's member attribute in the remote LDAP or AD group. Sample: True \| \| client\_cert string \| changed \| The name of an SSL client certificate. Sample: MyCert.crt \| \| client\_key string \| changed \| The name of an SSL client key. Sample: MyKey.key \| \| fallback\_to\_local boolean \| changed \| Specifies the system uses the Local authentication method as fallback Sample: True \| \| login\_ldap\_attr string \| changed \| The LDAP directory attribute containing the local user name associated with the selected directory entry. Sample: samaccountname \| \| port integer \| changed \| The port the system uses for access to the remote LDAP server. Sample: 389 \| \| remote\_directory\_tree string \| changed \| File location (tree) of the user authentication database on the server. Sample: CN=Users,DC=FOOBAR,DC=LOCAL \| \| scope string \| changed \| The level of the remote Active Directory or LDAP directory searched for user authentication. Sample: base \| \| servers list / elements=string \| changed \| LDAP servers used by the system to obtain authentication information. Sample: ['192.168.1.1', '192.168.1.2'] \| \| ssl string \| changed \| Specifies whether the system uses an SSL port to communicate with the LDAP server. Sample: start-tls \| \| user\_template string \| changed \| The distinguished name of the user who is logging on. Sample: uid=%s,ou=people,dc=foobar,dc=local \| \| validate\_certs boolean \| changed \| Indicates if the system checks an SSL peer. Sample: True \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_asm_policy_fetch – Exports the ASM policy from remote nodes. f5networks.f5\_modules.bigip\_asm\_policy\_fetch – Exports the ASM policy from remote nodes. ============================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_asm_policy_fetch`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Exports the ASM policy from remote nodes. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| base64 boolean \| Choices:* no * yes \| If `yes`, the returned `inline` ASM policy content will be Base64 encoded. Only applies to `inline` ASM policy exports. \| \| binary boolean \| Choices:* no * yes \| If `yes`, the exported ASM policy will be in binary format. Only applies to `file` ASM policy exports. \| \| compact boolean \| Choices:* no * yes \| If `yes`, only the ASM policy custom settings will be exported. Only applies to XML type ASM policy exports. \| \| dest path \| \| A directory to save the policy file into. This option is ignored when `inline` is set to c(yes). \| \| file string \| \| The name of the file to be created on the remote device for downloading. When `binary` is set to `no` the ASM policy will be in XML format. \| \| force boolean \| Choices:* no * yes ← \| If `no`, the file will only be transferred if it does not exist in the the destination. \| \| inline boolean \| Choices:* no * yes \| If `yes`, the ASM policy will be exported `inline` as a string instead of a file. The policy can be be retrieved in the playbook `result` dictionary under the `inline_policy` key. \| \| name string / required \| \| The name of the policy exported to create a file on the remote device for downloading. \| \| partition string \| Default:"Common" \| Device partition which contains the ASM policy to export. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Export policy in binary format bigip_asm_policy_fetch: name: foobar file: export_foo dest: /root/download binary: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Export policy inline base64 encoded format bigip_asm_policy_fetch: name: foobar inline: yes base64: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Export policy in XML format bigip_asm_policy_fetch: name: foobar file: export_foo dest: /root/download provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Export compact policy in XML format bigip_asm_policy_fetch: name: foobar file: export_foo.xml dest: /root/download/ compact: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Export policy in binary format, autogenerate name bigip_asm_policy_fetch: name: foobar dest: /root/download/ binary: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| base64 boolean \| changed \| Set to encode inline export in Base64 format. \| \| binary boolean \| changed \| Set to export the ASM policy in binary format. Sample: True \| \| compact boolean \| changed \| Set only to export custom ASM policy settings. \| \| dest string \| changed \| Local path to download the exported ASM policy. Sample: /root/downloads/foobar.xml \| \| file string \| changed \| Name of the policy file on the remote BIG-IP to download. If not specified, then this will be a randomly generated filename. Sample: foobar.xml \| \| inline boolean \| changed \| Set when the ASM policy to be exported is inline Sample: True \| \| name string \| changed \| Name of the ASM policy to be exported. Sample: Asm\_APP1\_Transparent \| ### Authors * Wojciech Wypior (@wojtek0806) * Nitin Khanna (@nitinthewiz) ansible f5networks.f5_modules.bigip_firewall_rule_list – Manage AFM security firewall policies on a BIG-IP f5networks.f5\_modules.bigip\_firewall\_rule\_list – Manage AFM security firewall policies on a BIG-IP ====================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_rule_list`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages AFM (Advanced Firewall Manager) security firewall policies on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description to attach to the policy. This parameter is only supported on versions of BIG-IP >= 12.1.0. On earlier versions it is ignored. \| \| name string / required \| \| The name of the policy to create. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rules list / elements=string \| \| Specifies a list of rules you want associated with this policy. The order of this list is the order they will be evaluated by BIG-IP. If the specified rules do not exist (for example when creating a new policy) then they will be created. Rules specified here, if they do not exist, will be created with "default deny" behavior. It is expected that you follow-up this module with the actual configuration for these rules. The `bigip_firewall_rule` module can also be used to create, as well as edit, existing and new rules. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the rule list exists. When `state` is `absent`, ensures the rule list is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a basic policy with some rule stubs bigip_firewall_rule_list: name: foo rules: - rule1 - rule2 - rule3 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the policy. Sample: My firewall policy \| \| rules list / elements=string \| changed \| The list of rules on the device, in the order that they are evaluated. Sample: ['rule1', 'rule2', 'rule3'] \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_oracle – Manages BIG-IP Oracle monitors f5networks.f5\_modules.bigip\_monitor\_oracle – Manages BIG-IP Oracle monitors ============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_oracle`. New in version 1.3.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IP Oracle monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| app\_service string \| \| The iApp service to be associated with this profile. When no service is specified, the default is None. \| \| count integer \| \| Specifies the number of monitor probes after which the connection to the database will be terminated. Count value of zero indicates that the connection will never be terminated. \| \| database string \| \| Specifies the name of the database the monitor tries to access. \| \| debug boolean \| Choices:* no * yes \| Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. \| \| description string \| \| Specifies descriptive text that identifies the monitor. \| \| interval integer \| \| Specifies the frequency, in seconds, at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| manual\_resume* boolean \| Choices:* no * yes \| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to `yes`, you must manually re-enable the resource before the system can use it for load balancing connections. When `yes`, specifies you must manually re-enable the resource after an unsuccessful monitor check. When `no`, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. \| \| name string / required \| \| Monitor name. \| \| parent string \| \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `oracle` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must specify a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| recv string \| \| Specifies the text string that the monitor looks for in the returned resource. The most common receive expressions contain a text string that is included in a field in your database. If you do not specify both `send` and a `recv` parameters, the monitor performs a simple service check and connect only. \| \| recv\_column string \| \| Specifies the column in the database where the specified `recv` string should be located. This is an optional setting and is applicable only if you configure the `send` and the `recv` parameters. \| \| recv\_row string \| \| Specifies the row in the database where the specified `recv` string should be located. This is an optional setting, and is applicable only if you configure the `send` and the `recv` parameters. \| \| send string \| \| Specifies the SQL query the monitor sends to the target object. Since the string may have special characters, the system may require the string be enclosed with single quotation marks. If this value is `none`, a valid connection suffices to determine the service is up. In this case, the system does not need the recv, recv-row, and recv-column options and ignores them even if not `none`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password, if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name, if the monitored target requires authentication. \| \| time\_until\_up integer \| \| Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked 'up'. A value of 0 means the resource is marked up immediately upon receipt of the first correct response. \| \| timeout integer \| \| Specifies the number of seconds the target has in which to respond to the monitor request. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that `timeout` and `time_until_up` combine to control when a resource is set to up. \| \| up\_interval integer \| \| Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval in `interval` to check the health of the resource. When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will update passwords if the `target_password` is specified. `on_create` will only set the password for newly created monitors. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an oracle monitor bigip_monitor_oracle: ip: 10.10.10.10 port: 10923 name: my_oracle_monitor send: "SELECT status FROM v$instance" recv: OPEN recv_column: 2 recv_row: 1 database: primary1 target_username: bigip target_password: secret update_password: on_create state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Modify an oracle monitor bigip_monitor_oracle: name: my_oracle_monitor recv_column: 4 recv_row: 3 database: primary2 state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove oracle monitor bigip_monitor_oracle: state: absent name: my_oracle_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| app\_service string \| changed \| The iApp service associated with this monitor. Sample: /Common/good\_service.app/good\_service \| \| database string \| changed \| The name of the database that the monitor tries to access. Sample: primary1 \| \| debug boolean \| changed \| Whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| manual\_resume boolean \| changed \| Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True \| \| parent string \| changed \| The parent monitor. Sample: /Common/foo\_oracle \| \| port string \| changed \| Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Sample: 80 \| \| recv string \| changed \| The text string that the monitor looks for in the returned resource. Sample: OPEN \| \| recv\_column string \| changed \| The column in the database where the specified string should be located. Sample: 2 \| \| recv\_row string \| changed \| The row in the database where the specified string should be located. Sample: 1 \| \| send string \| changed \| The SQL query the monitor sends to the target object. Sample: SELECT status FROM v$instance \| \| target\_username string \| changed \| The user name for the the monitored target. Sample: bigip \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| up\_interval integer \| changed \| Interval for the system to use to perform the health check when a resource is up. \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_gtm_monitor_http – Manages F5 BIG-IP GTM HTTP monitors f5networks.f5\_modules.bigip\_gtm\_monitor\_http – Manages F5 BIG-IP GTM HTTP monitors ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_monitor_http`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP GTM (now BIG-IP DNS) HTTP monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| ignore\_down\_response boolean \| Choices:* no * yes \| Specifies the monitor allows more than one probe attempt per interval. When `yes`, specifies the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down. When `no`, specifies the monitor immediately marks an object down when it receives a down response. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value will be 30. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. If this value is an IP address, then a `port` number must be specified. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/http" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `http` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. If specifying an IP address, you must use a value between 1 and 65535. \| \| probe\_timeout* integer \| \| Specifies the number of seconds after which the system times out the probe request to the system. When creating a new monitor, if this parameter is not provided, the default value will be `5`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| receive string \| \| The receive string for the monitor call. \| \| reverse boolean \| Choices:* no * yes \| Instructs the system to mark the target resource down when the test is successful. This setting is useful, for example, if the content on your web site home page is dynamic and changes frequently, you may want to set up a reverse ECV service check that looks for the string Error. A match for this string means the web server was down. To use this option, you must specify values for `send` and `receive`. \| \| send string \| \| The send string for the monitor call. When creating a new monitor, if this parameter is not provided, the default of `GET /\r\n` will be used. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password, if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name, if the monitored target requires authentication. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then default value will be 120. \| \| transparent boolean \| Choices:* no * yes \| Specifies whether the monitor operates in transparent mode. A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the `ip`-`port` combination specified in the monitor). If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will update passwords if the `target_password` is specified. `on_create` will only set the password for newly created monitors. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a GTM HTTP monitor bigip_gtm_monitor_http: name: my_monitor ip: 1.1.1.1 port: 80 send: my send string receive: my receive string state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove HTTP Monitor bigip_gtm_monitor_http: name: my_monitor state: absent provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add HTTP monitor for all addresses, port 514 bigip_gtm_monitor_http: name: my_monitor port: 514 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| ignore\_down\_response boolean \| changed \| Whether to ignore the down response or not. Sample: True \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: http \| \| port string \| changed \| The new port the monitor checks the resource on. Sample: 8080 \| \| probe\_timeout integer \| changed \| The new timeout in which the system will timeout the monitor probe. Sample: 10 \| \| receive string \| changed \| The new receive string for this monitor. Sample: tcp string to receive \| \| reverse boolean \| changed \| The new value for whether the monitor operates in reverse mode. \| \| send string \| changed \| The new send string for this monitor. Sample: tcp string to send \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| transparent boolean \| changed \| The new value for whether the monitor operates in transparent mode. \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_pool – Manages F5 BIG-IP LTM pools f5networks.f5\_modules.bigip\_pool – Manages F5 BIG-IP LTM pools ================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_pool`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM pools via iControl REST API. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| aggregate list / elements=dictionary \| \| List of pool definitions to be created, modified, or removed. When using `aggregates`, if one of the aggregate definitions is invalid, the aggregate run will fail, indicating the error it last encountered. The module will NOT rollback any changes it has made prior to encountering the error. The module also will not indicate which changes were made prior to failure. Therefore we strongly advise you run the module in `check` mode to ensure basic validation prior to executing this module. aliases: pools \| \| description string \| \| Specifies descriptive text that identifies the pool. \| \| lb\_method string \| Choices:* dynamic-ratio-member * dynamic-ratio-node * fastest-app-response * fastest-node * least-connections-member * least-connections-node * least-sessions * observed-member * observed-node * predictive-member * predictive-node * ratio-least-connections-member * ratio-least-connections-node * ratio-member * ratio-node * ratio-session * round-robin * weighted-least-connections-member * weighted-least-connections-node \| Load balancing method. When creating a new pool, if this value is not specified, the default of `round-robin` is used. \| \| metadata raw \| \| Arbitrary key/value pairs you can attach to a pool. This is useful in situations where you might want to annotate a pool to be managed by Ansible. Key names are stored as strings; this includes names that are numbers. Values for all of the keys are stored as strings; this includes values that are numbers. Data will be persisted, not ephemeral. \| \| monitor\_type string \| Choices:* and\_list * m\_of\_n * single \| Monitor rule type when `monitors` is specified. When creating a new pool, if this value is not specified, the default of `and_list` is used. When `single`, ensures all specified monitors are checked, but additionally includes checks to make sure you only specified a single monitor. When `and_list`, ensures all monitors are checked. When `m_of_n`, ensures `quorum` of `monitors` are checked. `m_of_n` requires a `quorum` of 1 or greater be set either in the playbook, or already exist on the device. Both `single` and `and_list` are functionally identical, as BIG-IP considers all monitors as "a list". \| \| monitors list / elements=string \| \| Monitor template name list. If the partition is not provided as part of the monitor name, the `partition` option is used instead. \| \| name string \| \| Pool name aliases: pool \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| priority\_group\_activation integer \| \| Specifies whether the system load balances traffic according to the priority number assigned to the pool member. When creating a new pool, if this parameter is not specified, the default of `0` is used. To disable this setting, provide the value `0`. Once you enable this setting, you can specify pool member priority when you create a new pool or on a pool member's properties screen. The system treats same-priority pool members as a group. To enable priority group activation, provide a number from `0` to `65535` that represents the minimum number of members that must be available in one priority group before the system directs traffic to members in a lower priority group. When a sufficient number of members become available in the higher priority group, the system again directs traffic to the higher priority group. aliases: minimum\_active\_members \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| quorum integer \| \| Monitor quorum value when `monitor_type` is `m_of_n`. Quorum must be a value of 1 or greater when `monitor_type` is `m_of_n`. \| \| replace\_all\_with boolean \| Choices:* no ← * yes \| Removes pools not defined in the `aggregate` parameter. This operation is all or none, meaning it will stop if there are some pools that cannot be removed. aliases: purge \| \| reselect\_tries integer \| \| Sets the number of times the system tries to contact a pool member after a passive failure. \| \| service\_down\_action string \| Choices:* none * reset * drop * reselect \| Sets the action to take when node goes down in pool. \| \| slow\_ramp\_time integer \| \| Sets the ramp-up time (in seconds) to gradually ramp up the load on newly added or freshly detected up pool members. \| \| state string \| Choices:* absent * present ← \| When `present`, guarantees the pool exists with the provided attributes. When `absent`, removes the pool from the system. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create pool bigip_pool: state: present name: my-pool partition: Common lb_method: least-connections-member slow_ramp_time: 120 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Modify load balancer method bigip_pool: state: present name: my-pool partition: Common lb_method: round-robin provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Set a single monitor (with enforcement) bigip_pool: state: present name: my-pool partition: Common monitor_type: single monitors: - http provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Set a single monitor (without enforcement) bigip_pool: state: present name: my-pool partition: Common monitors: - http provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Set multiple monitors (all must succeed) bigip_pool: state: present name: my-pool partition: Common monitor_type: and_list monitors: - http - tcp provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Set multiple monitors (at least 1 must succeed) bigip_pool: state: present name: my-pool partition: Common monitor_type: m_of_n quorum: 1 monitors: - http - tcp provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Delete pool bigip_pool: state: absent name: my-pool partition: Common provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add metadata to pool bigip_pool: state: present name: my-pool partition: Common metadata: ansible: 2.4 updated_at: 2017-12-20T17:50:46Z provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add pools Aggregate bigip_pool: aggregate: - name: my-pool partition: Common lb_method: least-connections-member slow_ramp_time: 120 - name: my-pool2 partition: Common lb_method: least-sessions slow_ramp_time: 120 - name: my-pool3 partition: Common lb_method: round-robin slow_ramp_time: 120 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add pools Aggregate, purge others bigip_pool: aggregate: - name: my-pool partition: Common lb_method: least-connections-member slow_ramp_time: 120 - name: my-pool2 partition: Common lb_method: least-sessions slow_ramp_time: 120 - name: my-pool3 partition: Common lb_method: round-robin slow_ramp_time: 120 replace_all_with: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| Description set on the pool. Sample: Pool of web servers \| \| lb\_method string \| changed \| The load balancing method set for the pool. Sample: round-robin \| \| metadata dictionary \| changed \| The new value of the pool. Sample: {'key1': 'foo', 'key2': 'bar'} \| \| monitor\_type string \| changed \| Changed value for the monitor\_type of the pool. Sample: m\_of\_n \| \| monitors list / elements=string \| changed \| Monitors set on the pool. Sample: ['/Common/http', '/Common/gateway\_icmp'] \| \| priority\_group\_activation integer \| changed \| The new minimum number of members to activate the priority group. Sample: 10 \| \| quorum integer \| changed \| The quorum that was set on the pool. Sample: 2 \| \| replace\_all\_with boolean \| changed \| Purges all non-aggregate pools from device Sample: True \| \| reselect\_tries integer \| changed \| The new value set for the number of tries to contact member. Sample: 10 \| \| service\_down\_action string \| changed \| Service down action that is set on the pool. Sample: reset \| \| slow\_ramp\_time integer \| changed \| The new value set for the slow ramp-up time. Sample: 500 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_password_policy – Manages the authentication password policy on a BIG-IP f5networks.f5\_modules.bigip\_password\_policy – Manages the authentication password policy on a BIG-IP ======================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_password_policy`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages the authentication password policy on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| expiration\_warning integer \| \| Specifies the number of days before a password expires. This value determines when the BIG-IP system automatically warns users their password is about to expire. \| \| max\_duration integer \| \| Specifies the maximum number of days a password is valid. \| \| max\_login\_failures integer \| \| Specifies the number of consecutive unsuccessful login attempts the system allows before locking out the user. Specify zero (0) to disable this parameter. \| \| min\_duration integer \| \| Specifies the minimum number of days a password is valid. \| \| min\_length integer \| \| Specifies the minimum number of characters in a valid password. This value must be between 6 and 255. \| \| password\_memory integer \| \| Specifies whether the user has configured the BIG-IP system to remember a password on a specific computer and how many passwords to remember. \| \| policy\_enforcement boolean \| Choices:* no * yes \| Enables or disables the password policy on the BIG-IP system. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| required\_lowercase integer \| \| Specifies the number of lowercase alpha characters that must be present in a password for the password to be valid. \| \| required\_numeric integer \| \| Specifies the number of numeric characters that must be present in a password for the password to be valid. \| \| required\_special integer \| \| Specifies the number of special characters that must be present in a password for the password to be valid. \| \| required\_uppercase integer \| \| Specifies the number of uppercase alpha characters that must be present in a password for the password to be valid. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Change password policy to require 2 numeric characters bigip_password_policy: required_numeric: 2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| expiration\_warning integer \| changed \| The new expiration warning. Sample: 7 \| \| max\_duration integer \| changed \| The new max duration. Sample: 99999 \| \| max\_login\_failures integer \| changed \| The new max login failures. \| \| min\_duration integer \| changed \| The new minimum duration. \| \| min\_length integer \| changed \| The new minimum password length. Sample: 6 \| \| password\_memory integer \| changed \| The new number of remembered passwords \| \| policy\_enforcement boolean \| changed \| The new policy enforcement setting. Sample: True \| \| required\_lowercase integer \| changed \| The lowercase requirement. Sample: 1 \| \| required\_numeric integer \| changed \| The numeric requirement. Sample: 2 \| \| required\_special integer \| changed \| The special character requirement. Sample: 1 \| \| required\_uppercase integer \| changed \| The uppercase character requirement. Sample: 1 \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_gtm_wide_ip – Manages F5 BIG-IP GTM Wide IP f5networks.f5\_modules.bigip\_gtm\_wide\_ip – Manages F5 BIG-IP GTM Wide IP =========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_wide_ip`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages the F5 BIG-IP GTM (now BIG-IP DNS) Wide IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| aliases list / elements=string \| \| Specifies alternate domain names for the web site content you are load balancing. You can use the same wildcard characters for aliases as you can for actual Wide IP names. \| \| irules list / elements=string \| \| List of rules to be applied. If you want to remove all existing iRules, specify a single empty value; `""`. See the documentation for an example. \| \| last\_resort\_pool string \| \| Specifies which GTM pool for the system to use as the last resort pool for the Wide IP. The valid pools for this parameter are those with the `type` specified in this module. \| \| name string / required \| \| Wide IP name. This name must be formatted as a fully qualified domain name (FQDN). You can also use the alias `wide_ip` but this is deprecated and will be removed in a future Ansible version. aliases: wide\_ip \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| persist\_cidr\_ipv4 integer \| \| Specifies a mask used to group IPv4 LDNS addresses. This feature allows one persistence record to be shared by LDNS addresses that match within this mask. \| \| persist\_cidr\_ipv6 integer \| \| Specifies a mask used to group IPv6 LDNS addresses. This feature allows one persistence record to be shared by LDNS addresses that match within this mask. \| \| persistence boolean \| Choices:* no * yes \| When `yes`, ensures that when a local DNS makes repetitive requests on behalf of a client, the system reconnects the client to the same resource as previous requests. When `no`, ensures repetitive requests do not reconnect the client to the same resource. \| \| persistence\_ttl integer \| \| Specifies the time to maintain a connection between an local DNS and a particular virtual server. \| \| pool\_lb\_method string \| Choices:* round-robin * ratio * topology * global-availability \| Specifies the load balancing method used to select a pool in this wide IP. This setting is relevant only when multiple pools are configured for a Wide IP. aliases: lb\_method \| \| pools list / elements=dictionary \| \| The pools you want associated with the Wide IP. If `ratio` is not provided when creating a new Wide IP, it will default to 1. \| \| \| name string / required \| \| The name of the pool to include. \| \| \| order integer \| \| Order of the pool in relation to other pools attached to this Wide IP. Pool order is significant when the Global Availability load balancing method is used. When `order` is not provided, the module assigns it value of `0`. \| \| \| ratio integer \| \| Ratio for the pool. The system uses this number with the Ratio load balancing method. When `ratio` is not provided, the module assigns it value of `0`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent * disabled * enabled \| When `present` or `enabled`, ensures the Wide IP exists and is enabled. When `absent`, ensures the Wide IP has been removed. When `disabled`, ensures the Wide IP exists and is disabled. \| \| type string / required \| Choices:* a * aaaa * cname * mx * naptr * srv \| Specifies the type of Wide IP. GTM Wide IPs need to be keyed by query type in addition to name, because pool members need different attributes depending on the response RDATA they are meant to supply. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set lb method bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com type: a provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add iRules to the Wide IP bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com type: a irules: - irule1 - irule2 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove one iRule from the Virtual Server bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com type: a irules: - irule1 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove all iRules from the Virtual Server bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com type: a irules: "" provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Assign a pool with ratio to the Wide IP bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com type: a pools: - name: pool1 ratio: 100 order: 2 - name: pool1 ratio: 100 order: 1 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Assign a pool with persistence to the Wide IP bigip_gtm_wide_ip: pool_lb_method: round-robin name: my-wide-ip.example.com type: a pools: - name: pool1 persistence: yes persist_cidr_ipv4: 24 persist_cidr_ipv6: 120 persistence_ttl: 3500 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| aliases list / elements=string \| changed \| Aliases set on the Wide IP. Sample: ['alias1.foo.com', '\.wildcard.domain'] \| \| irules* list / elements=string \| changed \| iRules set on the Wide IP. Sample: ['/Common/irule1', '/Common/irule2'] \| \| lb\_method string \| changed \| The new load balancing method used by the Wide IP. Sample: topology \| \| persist\_cidr\_ipv4 integer \| changed \| Specifies a mask used to group IPv4 LDNS addresses. Sample: 32 \| \| persist\_cidr\_ipv6 integer \| changed \| Specifies a mask used to group IPv6 LDNS addresses. Sample: 128 \| \| persistence boolean \| changed \| Whether pool connections will be persisted. \| \| persistence\_ttl integer \| changed \| Specifies the persistence TTL between an local DNS and a particular virtual server. Sample: 3600 \| \| state string \| changed \| The new state of the Wide IP. Sample: disabled \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_ssl_csr – Create SSL CSR files on the BIG-IP f5networks.f5\_modules.bigip\_ssl\_csr – Create SSL CSR files on the BIG-IP =========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ssl_csr`. New in version 1.3.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module will create SSL CSR files on a BIG-IP. CSRs require an associated SSL key to pre-exist on the BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| common\_name string \| \| The certificate common name. \| \| dest path / required \| \| Destination on your local filesystem when you want to save the CSR file. \| \| force boolean \| Choices:* no * yes ← \| If `no`, the file will only be transferred if the destination does not exist. \| \| key\_name string \| \| The SSL key to be used to generate the CSR. \| \| name string / required \| \| The name of the CSR file. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource does not exist. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an SSL csr bigip_ssl_csr: name: csr-name key_name: key-name common_name: csr-name dest: /tmp/csr-name provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| common\_name string \| created \| The common name of the CSR file. Sample: csr-name \| \| csr\_name string \| created \| The name of the CSR file. Sample: csr-name \| ### Authors * Nitin Khanna (@nitinthewiz) ansible f5networks.f5_modules.bigip_smtp – Manages SMTP settings on the BIG-IP f5networks.f5\_modules.bigip\_smtp – Manages SMTP settings on the BIG-IP ======================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_smtp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Allows configuring of the BIG-IP to send mail via an SMTP server by configuring the parameters of an SMTP server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| authentication boolean \| Choices:* no * yes \| Credentials can be set on an SMTP server's configuration even if that authentication is not used (for example, staging configs or emergency changes). This parameter acts as a switch to make the specified `smtp_server_username` and `smtp_server_password` parameters active or not. When `yes`, the authentication parameters are active. When `no`, the authentication parameters are inactive. \| \| encryption string \| Choices:* none * ssl * tls \| Specifies whether the SMTP server requires an encrypted connection in order to send mail. \| \| from\_address string \| \| Email address the email is being sent from. This is the "Reply-to" address the recipient sees. \| \| local\_host\_name string \| \| Hostname used in SMTP headers in the format of a fully qualified domain name. This setting does not refer to the hostname of the BIG-IP system. \| \| name string / required \| \| Specifies the name of the SMTP server configuration. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| smtp\_server string \| \| SMTP server host name in the format of a fully qualified domain name. This value is required when creating a new SMTP configuration. \| \| smtp\_server\_password string \| \| Password the SMTP server requires when validating a user. \| \| smtp\_server\_port integer \| \| Specifies the SMTP port number. When creating a new SMTP configuration, the default is `25` when `encryption` is `none` or `tls`. The default is `465` when `ssl` is selected. \| \| smtp\_server\_username string \| \| User name the SMTP server requires when validating a user. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the SMTP configuration exists. When `absent`, ensures the SMTP configuration does not exist. \| \| update\_password string \| Choices:* always ← * on\_create \| Passwords are stored encrypted, so the module cannot know if the supplied `smtp_server_password` is the same or different than the existing password. This parameter controls the updating of the `smtp_server_password` credential. When `always`, the system always updates the password. When `on_create`, the system only sets the password for newly created SMTP server configurations. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a base SMTP server configuration bigip_smtp: name: my-smtp smtp_server: 1.1.1.1 smtp_server_username: mail-admin smtp_server_password: mail-secret local_host_name: smtp.mydomain.com from_address: [email protected] state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| authentication boolean \| changed \| Whether the authentication parameters are active or not. Sample: True \| \| encryption string \| changed \| The new `encryption` value of the SMTP configuration. Sample: tls \| \| from\_address string \| changed \| The new `from_address` value of the SMTP configuration. Sample: [email protected] \| \| local\_host\_name string \| changed \| The new `local_host_name` value of the SMTP configuration. Sample: smtp.mydomain.com \| \| smtp\_server string \| changed \| The new `smtp_server` value of the SMTP configuration. Sample: mail.mydomain.com \| \| smtp\_server\_port integer \| changed \| The new `smtp_server_port` value of the SMTP configuration. Sample: 25 \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_profile_ftp – Manages FTP profiles f5networks.f5\_modules.bigip\_profile\_ftp – Manages FTP profiles ================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_ftp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages FTP profiles on the BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allow\_ftps boolean \| Choices:* no * yes \| Allows explicit FTPS negotiation. \| \| description string \| \| Description of the profile. \| \| inherit\_parent\_profile boolean \| Choices:* no * yes \| Enables the FTP data channel to inherit the TCP profile used by the control channel. When `no`, the data channel uses FastL4 (BigProto) only. \| \| log\_profile string \| \| Configures the ALG log profile that controls logging. \| \| log\_publisher string \| \| Configures the log publisher that handles events logging for this profile. \| \| name string / required \| \| Specifies the name of the profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `ftp` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port integer \| \| Specifies a service for the data channel port used for this FTP profile. Valid range of values is between `0` and `65535` inclusive. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| security boolean \| Choices:* no * yes \| Enables secure FTP traffic for the BIG-IP Application Security Manager. This option can only be used if the system is licensed for the BIG-IP ASM. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the ftp profile exists. When `state` is `absent`, ensures the ftp profile is removed. \| \| translate\_extended boolean \| Choices:* no * yes \| Translates RFC 2428 extended requests `EPSV` and `EPRT` to `PASV` and `PORT` when communicating with IPv4 servers. This option can only be used if the system is licensed for the BIG-IP Application Security Manager (ASM). \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an ftp profile bigip_profile_ftp: name: foo parent: /Common/barfoo port: 2221 allow_ftps: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify an ftp profile bigip_profile_ftp: name: foo log_profile: /Common/alg_log log_publisher: /Common/foo_publisher security: yes description: my description provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove an ftp profile bigip_profile_ftp: name: foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| allow\_ftps boolean \| changed \| Allow explicit FTPS negotiation. Sample: True \| \| description string \| changed \| Description of the profile. Sample: Foo is bar \| \| inherit\_parent\_profile boolean \| changed \| Enables the FTP data channel to inherit the TCP profile used by the control channel. \| \| log\_profile string \| changed \| The ALG log profile that controls logging. Sample: /Common/foo\_log\_profile \| \| log\_publisher list / elements=string \| changed \| The name of the log publisher that handles events logging for this profile. Sample: /Common/publisher\_1 \| \| parent string \| changed \| Specifies the profile from which this profile inherits settings. Sample: /Common/ftp \| \| port integer \| changed \| Specifies a service for the data channel port used for this FTP profile. Sample: 20 \| \| security boolean \| changed \| Enables secure FTP traffic for the BIG-IP Application Security Manager. \| \| translate\_extended boolean \| changed \| Translates RFC 2428 extended requests when communicating with IPv4 servers. Sample: True \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_monitor_http – Manages F5 BIG-IP LTM HTTP monitors f5networks.f5\_modules.bigip\_monitor\_http – Manages F5 BIG-IP LTM HTTP monitors ================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_http`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM HTTP monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value is 5. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/http" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `http` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must specify a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| receive string \| \| The Receive string for the monitor call. \| \| receive\_disable string \| \| This setting works like `receive`, except the system marks the node or pool member disabled when its response matches the `receive_disable` string but not `receive`. To use this setting, you must specify both `receive_disable` and `receive`. \| \| reverse boolean \| Choices:* no * yes \| Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up. You can use the this mode only if you configure the `receive` option. This parameter is not compatible with the `time_until_up` parameter. If `time_until_up` is specified, it must be `0`. Or, if it already exists, it must be `0`. \| \| send string \| \| The Send string for the monitor call. When creating a new monitor, if this value is not provided, the default `GET /\r\n` is used. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password, if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name, if the monitored target requires authentication. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node is marked up. A value of 0 causes a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, the default value will be 0. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value is 16. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create HTTP Monitor bigip_monitor_http: state: present ip: 10.10.10.10 name: my_http_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove HTTP Monitor bigip_monitor_http: state: absent name: my_http_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Include a username and password in the HTTP monitor bigip_monitor_http: state: absent name: my_http_monitor target_username: monitor_user target_password: monitor_pass provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The description of the monitor. Sample: Important\_Monitor \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: http \| \| reverse boolean \| changed \| Whether the monitor operates in reverse mode. Sample: True \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_message_routing_peer – Manage peers for routing generic message protocol messages f5networks.f5\_modules.bigip\_message\_routing\_peer – Manage peers for routing generic message protocol messages ================================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_message_routing_peer`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage peers for routing generic message protocol messages. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auto\_init boolean \| Choices:* no * yes \| If `yes`, the BIG-IP automatically creates outbound connections to the active pool members in the specified `pool` using the configuration of the specified `transport_config`. For auto-initialization to attempt to create a connection, the peer must be included in a route that is attached to a router instance. For each router instance the peer is contained in, a connection is initiated. The `auto_init` logic verifies at `auto_init_interval` if the a connection exists between the BIG-IP and the pool members of the pool. If a connection does not exist, it attempts to reestablish one. \| \| auto\_init\_interval integer \| \| Specifies the interval at which attempts to initiate a connection occur. The default value upon peer object creation, that is supplied by the system is `5000` milliseconds. The accepted range is between 0 and 4294967295 inclusive. \| \| connection\_mode string \| Choices:* per-blade * per-client * per-peer * per-tmm \| Specifies how the number of connections per host are to be limited. \| \| description string \| \| The user-defined description of the peer. \| \| name string / required \| \| Specifies the name of the peer to manage. \| \| number\_of\_connections integer \| \| Specifies the distribution of connections between the BIG-IP and a remote host. The accepted range is between 0 and 65535 inclusive. \| \| partition string \| Default:"Common" \| Device partition to create peer object on. \| \| pool string \| \| Specifies the name of the pool that messages are routed towards. The specified pool must be on the same partition as the peer. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| ratio integer \| \| Specifies the ratio to be used for selection of a peer within a list of peers in a LTM route. The accepted range is between 0 and 4294967295 inclusive. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the peer exists. When `absent`, ensures the peer is removed. \| \| transport\_config string \| \| The name of the LTM virtual or LTM transport-config to use for creating an outgoing connection. The resource must exist on the same partition as the peer object. \| \| type string \| Choices:* generic ← \| Parameter used to specify the type of the peer to manage. Default setting is `generic` with more options coming. \| Notes ----- Note * Requires BIG-IP >= 14.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a simple peer bigip_message_routing_peer: name: foobar provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create message routing peer with additional settings bigip_message_routing_peer: name: foobar connection_mode: per-blade pool: /baz/bar partition: baz transport_config: foovirtual ratio: 10 auto_init: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify message routing peer settings bigip_message_routing_peer: name: foobar partition: baz ratio: 20 auto_init_interval: 2000 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove message routing peer bigip_message_routing_peer: name: foobar partition: baz state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| auto\_init boolean \| changed \| Enables creation of outbound connections to the active pool members. Sample: True \| \| auto\_init\_interval integer \| changed \| The interval at which attempts to initiate a connection occur. Sample: 2000 \| \| connection\_mode string \| changed \| Specifies how the number of connections per host are to be limited. Sample: per-peer \| \| description string \| changed \| The user defined description of the peer. Sample: Some description \| \| number\_of\_connections integer \| changed \| The distribution of connections between the BIG-IP and a remote host. Sample: 2000 \| \| pool string \| changed \| The name of the pool that messages are routed towards. Sample: /Bazbar/foobar \| \| ratio integer \| changed \| The ratio to be used for selection of a peer within a list of peers in a LTM route. Sample: 500 \| \| transport\_config string \| changed \| The LTM virtual or LTM transport-config to use for creating an outgoing connection. Sample: /Common/foobar \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_trunk – Manage trunks on a BIG-IP f5networks.f5\_modules.bigip\_trunk – Manage trunks on a BIG-IP =============================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_trunk`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages trunks on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the trunk. \| \| frame\_distribution\_hash string \| Choices:* destination-mac * source-destination-ip * source-destination-mac \| Specifies the basis for the hash the system uses as the frame distribution algorithm. The system uses the resulting hash to determine which interface to use for forwarding traffic. When creating a new trunk, if this parameter is not specified, the default is `source-destination-ip`. When `source-destination-mac`, specifies the system bases the hash on the combined MAC addresses of the source and the destination. When `destination-mac`, specifies the system bases the hash on the MAC address of the destination. When `source-destination-ip`, specifies the system bases the hash on the combined IP addresses of the source and the destination. \| \| interfaces list / elements=string \| \| The interfaces that are part of the trunk. To clear the list of interfaces, specify an empty list. \| \| lacp\_enabled boolean \| Choices:* no * yes \| When `yes`, specifies the system supports the link aggregation control protocol (LACP), which monitors the trunk by exchanging control packets over the member links to determine the health of the links. If LACP detects a failure in a member link, it removes the link from the link aggregation. When creating a new trunk, if this parameter is not specified, LACP is `no`. LACP is disabled by default for backward compatibility. If this does not apply to your network, we recommend that you enable LACP. \| \| lacp\_mode string \| Choices:* active * passive \| Specifies the operation mode for link aggregation control protocol (LACP), if LACP is enabled for the trunk. When creating a new trunk, if this parameter is not specified, the default is `active`. When `active`, specifies the system periodically sends control packets regardless of whether the partner system has issued a request. When `passive`, specifies the system sends control packets only when the partner system has issued a request. \| \| lacp\_timeout string \| Choices:* long * short \| Specifies the rate at which the system sends the LACP control packets. When creating a new trunk, if this parameter is not specified, the default is `long`. When `long`, specifies the system sends an LACP control packet every 30 seconds. When `short`, specifies the system sends an LACP control packet every second. \| \| link\_selection\_policy string \| Choices:* auto * maximum-bandwidth \| Once the trunk is configured, specifies the policy the trunk uses to determine which member link (interface) can handle new traffic. When creating a new trunk, if this value is not specified, the default is `auto`. When `auto`, specifies the system automatically determines which interfaces can handle new traffic. For the `auto` option, the member links must all be the same media type and speed. When `maximum-bandwidth`, specifies the system determines which interfaces can handle new traffic based on the members' maximum bandwidth. \| \| name string / required \| \| Specifies the name of the trunk. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| qinq\_ethertype raw \| \| Specifies the ether-type value used for the packets handled on this trunk when it is a member in a QinQ VLAN. The ether-type can be set to any string containing a valid hexadecimal 16 bits number, or any of the well known ether-types; `0x8100`, `0x9100`, `0x88a8`. This parameter is not supported on Virtual Editions. You should always wrap this value in quotes to prevent Ansible from interpreting the value as a literal hexadecimal number and converting it to an integer. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a trunk on hardware bigip_trunk: name: trunk1 interfaces: - 1.1 - 1.2 link_selection_policy: maximum-bandwidth frame_distribution_hash: destination-mac lacp_enabled: yes lacp_mode: passive lacp_timeout: short provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| Description of the trunk. Sample: My trunk \| \| frame\_distribution\_hash string \| changed \| Hash the system uses as the frame distribution algorithm. Sample: src-dst-ipport \| \| interfaces list / elements=string \| changed \| Interfaces that are part of the trunk. Sample: ['int1', 'int2'] \| \| lacp\_enabled boolean \| changed \| Whether the system supports the link aggregation control protocol (LACP) or not. Sample: True \| \| lacp\_mode string \| changed \| Operation mode for LACP if the lacp option is enabled for the trunk. Sample: active \| \| lacp\_timeout string \| changed \| Rate at which the system sends the LACP control packets. Sample: long \| \| link\_selection\_policy string \| changed \| LACP policy the trunk uses to determine which member link (interface) can handle new traffic. Sample: auto \| \| qinq\_ethertype string \| changed \| Ether-type value used for the packets handled on this trunk when it is a member in a QinQ VLAN. Sample: 37120 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigiq_application_https_waf – Manages BIG-IQ HTTPS WAF applications f5networks.f5\_modules.bigiq\_application\_https\_waf – Manages BIG-IQ HTTPS WAF applications ============================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_application_https_waf`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IQ applications used for load balancing an HTTPS application on port 443 with a Web Application Firewall (WAF) using an ASM (Application Security Manager) Rapid Deployment policy. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| add\_analytics boolean \| Choices:* no ← * yes \| Collects statistics of the BIG-IP that the application is deployed to. This parameter is only relevant when specifying a `service_environment` which is a BIG-IP; not an SSG. \| \| client\_ssl\_profile dictionary \| \| Specifies the SSL profile for managing client-side SSL traffic. \| \| \| cert\_key\_chain raw \| \| One or more certificates and keys to associate with the SSL profile. This option is always a list. The keys in the list dictate the details of the client/key/chain/passphrase combination. BIG-IPs can only have one of each type of each certificate/key type. This means you can only have one RSA, one DSA, and one ECDSA per profile. If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo, the device rejects it. This list is a complex list that specifies a number of keys. When creating a new profile, if this parameter is not specified, the default value is `inherit`. \| \| \| \| cert string \| \| Specifies a cert name for use. \| \| \| \| chain string \| \| Specifies a certificate chain that is relevant to the certificate and key. This key is optional. \| \| \| \| key string \| \| Specifies a key name. \| \| \| \| passphrase string \| \| Contains the passphrase of the key file, should it require one. Passphrases are encrypted on the remote BIG-IP device. \| \| \| name string \| Default:"clientssl" \| The name of the client SSL profile to created and used. When creating a new application, if this value is not specified, the default value of `clientssl` will be used. \| \| description string \| \| Description of the application. \| \| domain\_names list / elements=string \| \| Specifies host names that are used to access the web application that this security policy protects. When creating a new application, this parameter is required. \| \| inbound\_virtual dictionary \| \| Settings to configure the virtual which receives the inbound connection. This virtual is used to host the HTTPS endpoint of the application. Traffic destined to the `redirect_virtual` is offloaded to this parameter to ensure proper redirection from insecure to secure occurs. \| \| \| address string / required \| \| Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. \| \| \| netmask string / required \| \| Specifies the netmask to associate with the given `destination`. This parameter is required when creating a new application. \| \| \| port string \| Default:443 \| The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is `443`. \| \| name string / required \| \| Name of the new application. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| redirect\_virtual dictionary \| \| Settings to configure the virtual which receives the connection to be redirected. This virtual is used to host the HTTP endpoint of the application. Traffic destined to this parameter is offloaded to the `inbound_virtual` parameter to ensure proper redirection from insecure to secure occurs. \| \| \| address string / required \| \| Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. \| \| \| netmask string / required \| \| Specifies the netmask to associate with the given `destination`. This parameter is required when creating a new application. \| \| \| port string \| Default:80 \| The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value of `80` will be used. \| \| servers list / elements=dictionary \| \| A list of servers on which the application is hosted. If you are familiar with other BIG-IP settings, you might also refer to this list as the list of pool members. When creating a new application, at least one server is required. \| \| \| address string / required \| \| The IP address of the server. \| \| \| port string \| Default:80 \| The port of the server. \| \| service\_environment string \| \| Specifies the name of service environment the application will be deployed to. When creating a new application, this parameter is required. \| \| state string \| Choices:* absent * present ← \| The state of the resource on the system. When `present`, guarantees the resource exists with the provided attributes. When `absent`, removes the resource from the system. \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the application to be created, deleted, or updated. \| Notes ----- Note * This module does not work on BIG-IQ version 6.1.x or greater. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Load balance an HTTPS application on port 443 with a WAF using ASM bigiq_application_https_waf: name: my-app description: Redirect HTTP to HTTPS via WAF service_environment: my-ssg servers: - address: 1.2.3.4 port: 8080 - address: 5.6.7.8 port: 8080 inbound_virtual: address: 2.2.2.2 netmask: 255.255.255.255 port: 443 redirect_virtual: address: 2.2.2.2 netmask: 255.255.255.255 port: 80 provider: password: secret server: lb.mydomain.com user: admin state: present delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the application of the resource. Sample: My application \| \| inbound\_virtual\_destination string \| changed \| The destination of the virtual that was created. Sample: 6.7.8.9 \| \| inbound\_virtual\_netmask string \| changed \| The network mask of the provided inbound destination. Sample: 255.255.255.0 \| \| inbound\_virtual\_port integer \| changed \| The port on which the inbound virtual address listens. Sample: 80 \| \| servers complex \| changed \| List of servers, and their ports, that make up the application. Sample: hash/dictionary of values \| \| \| address string \| changed \| The IP address of the server. Sample: 2.3.4.5 \| \| \| port integer \| changed \| The port on which the server listens. Sample: 8080 \| \| service\_environment string \| changed \| The environment to which the service was deployed. Sample: my-ssg1 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_snmp_trap – Manipulate SNMP trap information on a BIG-IP f5networks.f5\_modules.bigip\_snmp\_trap – Manipulate SNMP trap information on a BIG-IP ======================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_snmp_trap`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manipulate SNMP trap information on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| community string \| \| Specifies the community name for the trap destination. \| \| destination string \| \| Specifies the address for the trap destination. This can be either an IP address or a hostname. \| \| name string / required \| \| Name of the SNMP configuration endpoint. \| \| network string \| Choices:* other * management * default \| Specifies the name of the trap network. This option is not supported in versions of BIG-IP prior to 12.1.0, and is simply ignored on those versions. The value `default` was removed in BIG-IP version 13.1.0. Specifying this value when configuring a BIG-IP causes the module to stop and report an error. In this case, choose one of the other options, such as `management`. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Specifies the port for the trap destination. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| snmp\_version string \| Choices:* 1 * 2c \| Specifies to which Simple Network Management Protocol (SNMP) version the trap destination applies. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource does not exist. \| Notes ----- Note * This module only supports version v1 and v2c of SNMP. * The `network` option is not supported on versions of BIG-IP prior to 12.1.0 because the platform did not support that option until 12.1.0. If used on versions prior to 12.1.0, it is simply be ignored. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create snmp v1 trap bigip_snmp_trap: community: general destination: 1.2.3.4 name: my-trap1 network: management port: 9000 snmp_version: 1 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create snmp v2 trap bigip_snmp_trap: community: general destination: 5.6.7.8 name: my-trap2 network: default port: 7000 snmp_version: 2c provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| community list / elements=string \| changed and success \| The new `community` name for the trap destination. Sample: secret \| \| destination string \| changed and success \| The new address for the trap destination in either IP or hostname form. Sample: 1.2.3.4 \| \| network string \| changed and success \| The new name of the network the SNMP trap is on. Sample: management \| \| port string \| changed and success \| The new `port` of the trap destination. Sample: 900 \| \| snmp\_version string \| changed and success \| The new `snmp_version` configured on the remote device. Sample: 2c \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_policy_rule – Manage LTM policy rules on a BIG-IP f5networks.f5\_modules.bigip\_policy\_rule – Manage LTM policy rules on a BIG-IP ================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_policy_rule`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module manages LTM policy rules on a BIG-IP. Requirements ------------ The below requirements are needed on the host that executes this module. * BIG-IP >= v12.1.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| actions list / elements=dictionary \| \| The actions you want the policy rule to perform. The available attributes vary by the action, however, each action requires you specify a `type`. These conditions can be specified in any order. Despite the fact they are in a list, the order in the list does not matter to the BIG-IP. \| \| \| asm\_policy string \| \| ASM policy to enable. This parameter is only valid with the `enable` type. \| \| \| cookie\_expiry integer added in 1.1.0 of f5networks.f5\_modules \| \| Optional argument, specifying the time for which the session is persisted. This parameter is only valid with the `persist` type. \| \| \| cookie\_insert string added in 1.1.0 of f5networks.f5\_modules \| \| Cookie name on which you want to persist. This parameter is only valid with the `persist` type. \| \| \| disable\_target string added in 1.8.0 of f5networks.f5\_modules \| Choices:* server\_ssl * persist \| Target which you want to disable. This parameter is only valid with the `disable` type. \| \| \| event string \| \| Events on which actions, such as reset and forward, can be triggered. With the `set_variable` action, it is used for specifying an action event, such as request or response. Valid event choices for `forward` action type are: client\_accepted, proxy\_request request, ssl\_client\_hello and ssl\_client\_server\_hello\_send. Valid event choices for `reset` acton type are: client\_accepted, proxy\_connect proxy\_request, proxy\_response, request, response, server\_connected, ssl\_client\_hello, ssl\_client\_server\_hello\_send, ssl\_server\_handshake, ssl\_server\_hello, websocket\_request, websocket\_response. Valid event choices for `disable` acton type are: client\_accepted, proxy\_connect proxy\_request, proxy\_response, request, server\_connected. \| \| \| expression string \| \| A Tcl expression used with the `set_variable` action. \| \| \| http\_connect dictionary added in 1.8.0 of f5networks.f5\_modules \| \| HTTP Connect header that you want to replace. This parameter is only valid with the `replace` type. \| \| \| \| event string / required \| Choices:* client\_accepted * proxy\_connect * proxy\_request * proxy\_response * request * server\_connected * ssl\_client\_hello \| Type of event when the `http_connect` header is replaced. \| \| \| \| port integer \| \| The port number. If a port number is not provided, the value is set to 0 by default. Be explicit when defining rules, so the system does not override port values. \| \| \| \| value string / required \| \| The value of `http_connect`. \| \| \| http\_cookie dictionary added in 1.8.0 of f5networks.f5\_modules \| \| HTTP Cookie header you want to remove or insert. This parameter is only valid with the `remove` and `insert` type. \| \| \| \| event string / required \| Choices:* request * proxy\_connect * proxy\_request \| Type of event when the `http_cookie` is removed or inserted. \| \| \| \| name string / required \| \| The name of `http_cookie`. \| \| \| \| value string \| \| The value of `http_cookie`. This is a mandatory parameter when configured with `insert` type action. \| \| \| http\_header dictionary added in 1.8.0 of f5networks.f5\_modules \| \| HTTP Header that you want to remove or insert. This parameter is only valid with the `remove`, `insert` and `replace` type. \| \| \| \| event string / required \| Choices:* request * response * proxy\_connect * proxy\_request * proxy\_response \| Type of event when the `http_header` is removed, replaced, or inserted. The `request` and `response` events are only choices with `remove` and `insert` type. All of events are valid with `replace` type action. \| \| \| \| name string / required \| \| The name of `http_header`. \| \| \| \| value string \| \| The value of `http_header`. Mandatory parameter when configured with `insert` or `replace` type. \| \| \| http\_host dictionary added in 1.8.0 of f5networks.f5\_modules \| \| HTTP Host header you want to replace. This parameter is only valid with the `replace` type. \| \| \| \| event string / required \| Choices:* request * proxy\_connect * proxy\_request \| Type of event when the `http_host` is replaced. \| \| \| \| value string / required \| \| The value of `http_host`. \| \| \| http\_referer dictionary added in 1.8.0 of f5networks.f5\_modules \| \| HTTP Referer header you want to remove, replace, or insert. This parameter is only valid with the `remove`, `insert` and `replace` type. \| \| \| \| event string / required \| Choices:* request * proxy\_connect * proxy\_request \| Type of event when the c(http\_referer) is removed, replaced, or inserted. \| \| \| \| value string \| \| The value of `http_referer`. This is a mandatory parameter when configured with `insert` type action. This parameter is ignored for the `remove` type. This parameter is optional for the `replace` type. \| \| \| http\_set\_cookie dictionary added in 1.8.0 of f5networks.f5\_modules \| \| HTTP Set-Cookie header you want to remove or insert. This parameter is only valid with the `remove` or c(insert) type. \| \| \| \| name string / required \| \| The name of `http_set_cookie`. \| \| \| \| value string \| \| The value of `http_set_cookie`. This is a mandatory parameter when configured with `insert` type action. \| \| \| http\_uri dictionary added in 1.8.0 of f5networks.f5\_modules \| \| Replaces HTTP URI, path, or string. This parameter is only valid with the `replace` type. \| \| \| \| event string / required \| Choices:* request * proxy\_connect * proxy\_request \| Type of event when the `http_uri` is replaced. \| \| \| \| type string / required \| Choices:* path * query\_string * full\_string \| Specifies the part of the `http_uri` to be replaced. \| \| \| \| value string / required \| \| The value of `http_uri`. \| \| \| location string \| \| The new URL for which a redirect response is sent. A Tcl command substitution can be used for this field. \| \| \| node string added in 1.2.0 of f5networks.f5\_modules \| \| Node to which you want to forward traffic. This parameter is only valid with the `forward` type. \| \| \| pool string \| \| Pool to which you want to forward traffic. This parameter is only valid with the `forward` type. \| \| \| type string / required \| Choices:* forward * enable * ignore * redirect * reset * persist * set\_variable * remove * insert * replace * disable \| The action type. This value controls which of the following options are required. When `type` is `forward`, the system associates a given `pool`, or `virtual`, or `node` with this rule. When `type` is `enable`, the system associates a given `asm_policy` with this rule. When `type` is `ignore`, the system removes all existing actions from this rule. When `type` is `redirect`, the system redirects an HTTP request to a different URL. When `type` is `reset`, the system resets the connection upon `event`. When `type` is `persist`, the system associates `cookie_insert` and `cookie_expiry` with this rule. When `type` is `set_variable`, the system sets a variable based on the evaluated Tcl `expression` based on `event`. When `type` is `remove`, the system removes `http_set_cookie`, `http_referer`, `http_header` or `http_cookie` with this rule. When `type` is `insert`, the system inserts `http_set_cookie`, `http_referer`, `http_header` or `http_cookie` with this rule. When `type` is `replace`, the system replaces `http_connect`, `http_referer`, `http_header`, `http_uri` or `http_host` with this rule. When `type` is `disable`, the system disables `disable_target` with this rule. \| \| \| variable\_name string \| \| Variable name used with the `set_variable` action. \| \| \| virtual string \| \| Virtual server to which you want to forward traffic. This parameter is only valid with the `forward` type. \| \| conditions list / elements=dictionary \| \| A list of attributes that describe the condition. See suboptions for details on how to construct each list entry. The ordering of this list is important, the module ensures the order is kept when modifying the task. The suboption options below are not required for all condition types, read the description for more details. These conditions can be specified in any order. Despite the fact they are in a list, the order in the list does not matter to the BIG-IP. \| \| \| address\_matches\_with\_any list / elements=string added in 1.8.0 of f5networks.f5\_modules \| \| A list of IP Subnet address strings the IP address should match. This parameter is only valid with the `tcp` type. \| \| \| address\_matches\_with\_datagroup list / elements=string added in 1.8.0 of f5networks.f5\_modules \| \| A list of internal datagroup strings the IP address should match. This parameter is only valid with the `tcp` type. \| \| \| address\_matches\_with\_external\_datagroup list / elements=string added in 1.10.0 of f5networks.f5\_modules \| \| A list of external datagroup strings the IP address should match. This parameter is only valid with the `tcp` type. \| \| \| event string \| \| Events on which conditions type match rules can be triggered. Supported only for `http_header`, `http_method`, `ssl_extension` and `tcp`. Valid choices for `http_header` condition types are: `proxy_connect`, `proxy_request`, `proxy_response`, `request` and `response`. Valid choices for `http_method` condition types are: `proxy_connect`, `proxy_request`, `proxy_response`, `request` and `response`. Valid choices for `tcp` condition types are: `request`, `client_accepted`, `proxy_connect`, `proxy_request`, `proxy_response`, `ssl_client_hello`, and `ssl_client_server_hello_send`. Valid choices for `ssl_extension` are: `ssl_client_hello`, and `ssl_client_server_hello_send`. \| \| \| header\_is\_any list / elements=string added in 1.8.0 of f5networks.f5\_modules \| \| A list of strings of characters the HTTP Header value should match. This parameter is only valid with the `http_header` type. \| \| \| header\_name string added in 1.8.0 of f5networks.f5\_modules \| \| A name of `http_header`. This parameter is only valid with the `http_header` type. \| \| \| host\_begins\_with\_any list / elements=string \| \| A list of strings of characters the HTTP Host should start with. This parameter is only valid with the `http_host` type. \| \| \| host\_ends\_with\_any list / elements=string added in 1.8.0 of f5networks.f5\_modules \| \| A list of strings of characters the HTTP Host should end with. This parameter is only valid with the `http_host` type. \| \| \| host\_is\_any list / elements=string \| \| A list of strings of characters the HTTP Host should match. This parameter is only valid with the `http_host` type. \| \| \| host\_is\_not\_any list / elements=string \| \| A list of strings of characters the HTTP Host should not match. This parameter is only valid with the `http_host` type. \| \| \| method\_matches\_with\_any list / elements=string added in 1.10.0 of f5networks.f5\_modules \| \| A list of strings of characters the HTTP Method value should match. This parameter is only valid with the `http_method` type. \| \| \| path\_begins\_with\_any list / elements=string \| \| A list of strings of characters the HTTP URI should start with. This parameter is only valid with the `http_uri` type. \| \| \| path\_contains list / elements=string added in 1.8.0 of f5networks.f5\_modules \| \| A list of strings of characters the HTTP URI should contain. This parameter is only valid with the `http_uri` type. \| \| \| path\_is\_any list / elements=string added in 1.8.0 of f5networks.f5\_modules \| \| A list of strings of characters the HTTP URI should match. This parameter is only valid with the `http_uri` type. \| \| \| server\_name\_is\_any list / elements=string \| \| A list of strings of characters the SSL Extension should match. This parameter is only valid with the `ssl_extension` type. \| \| \| type string / required \| Choices:* http\_uri * all\_traffic * http\_host * http\_header * http\_method * ssl\_extension * tcp \| The condition type. This value controls which of the following options are required. When `type` is `http_uri`, the valid choices are: `path_begins_with_any`, `path_contains` or `path_is_any`. When `type` is `http_host`, the valid choices are: `host_is_any`, `host_is_not_any`, `host_begins_with_any` or `host_ends_with_any`. When `type` is `http_header`, the `header_name` parameter is mandatory and the valid choice is: `header_is_any`. When `type` is `http_method`, the valid choices are: `method_matches_with_any`. When `type` is `all_traffic`, the system removes all existing conditions from this rule. \| \| description string \| \| Description of the policy rule. \| \| name string / required \| \| The name of the rule. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| policy string / required \| \| The name of the policy you want to associate this rule with. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| replace\_with boolean \| Choices:* no ← * yes \| Specifies if the conditions given by the user should overwrite what exists on the device. The option is useful when a subset of conditions needs to be removed. This option is similar to the replace-all-with flag available in TMSH commands. Using this option is not idempotent. \| \| rule\_order integer added in 1.10.0 of f5networks.f5\_modules \| \| Specifies a number that indicates the order of this rule relative to other rules in the policy. When not set, the device sets the parameter to 0. If there are rules with the same rule order number, the device uses rule names to determine how the rules are ordered. The lower the number, the lower the rule is in the general order, with the lowest number `0` being the topmost one. Valid range of values is between `0` and `4294967295` inclusive. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the key is uploaded to the device. When `absent`, ensures the key is removed from the device. If the key is currently in use, the module will not be able to remove the key. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create policies bigip_policy: name: Policy-Foo state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add a rule to the new policy bigip_policy_rule: policy: Policy-Foo name: rule3 conditions: - type: http_uri path_begins_with_any: - /ABC actions: - type: forward pool: pool-svrs provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add multiple rules to the new policy bigip_policy_rule: policy: Policy-Foo name: "{{ item.name }}" conditions: "{{ item.conditions }}" actions: "{{ item.actions }}" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost loop: - name: rule1 actions: - type: forward pool: pool-svrs conditions: - type: http_uri path_begins_with_any: - /euro - name: rule2 actions: - type: forward pool: pool-svrs conditions: - type: http_uri path_begins_with_any: - /HomePage/ - name: rule3 actions: - type: set_variable variable_name: user-agent expression: tcl:[HTTP::header User-Agent] event: request conditions: - type: http_uri path_begins_with_any: - /HomePage/ - name: Remove all rules and conditions from the rule bigip_policy_rule: policy: Policy-Foo name: rule1 conditions: - type: all_traffic actions: - type: ignore provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| actions complex \| changed \| The new list of actions applied to the rule. Sample: hash/dictionary of values \| \| \| pool string \| changed \| Pool for forwarding to. Sample: foo-pool \| \| \| type string \| changed \| The action type. Sample: forward \| \| conditions complex \| changed \| The new list of conditions applied to the rule. Sample: hash/dictionary of values \| \| \| path\_begins\_with\_any list / elements=string \| changed \| List of strings the URI begins with. Sample: ['foo', 'bar'] \| \| \| type string \| changed \| The condition type. Sample: http\_uri \| \| description string \| changed \| The new description of the rule. Sample: My rule \| \| rule\_order integer \| changed \| Specifies a number that indicates the order of this rule relative to other rules in the policy. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.license_hopper – Return random license from list f5networks.f5\_modules.license\_hopper – Return random license from list ======================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.license_hopper`. New in version 1.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Select a random license key from a file and remove it from future lookups * Can optionally remove the key if `remove=True` is specified Examples -------- ``` - name: Get a regkey license from a stash without deleting it bigiq_regkey_license: key: "{{ lookup('license_hopper', 'filename=/path/to/licenses.txt') }}" state: present pool: regkey1 - name: Get a regkey license from a stash and delete the key from the file bigiq_regkey_license: key: "{{ lookup('license_hopper', 'filename=/path/to/licenses.txt', remove=True) }}" state: present pool: regkey1 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this lookup: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| \_raw string \| success \| random item \| ### Authors * Tim Rupp <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1f7c7e6f776d76722f2f28393c2c2824393c2a2d24393c2b272478727e7673393c2b29247c7072)> ansible f5networks.f5_modules.bigip_asm_policy_manage – Manage BIG-IP ASM policies f5networks.f5\_modules.bigip\_asm\_policy\_manage – Manage BIG-IP ASM policies ============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_asm_policy_manage`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP ASM policies, create policies from templates, and manage global policy settings. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| active boolean \| Choices:* no * yes \| If `yes`, will apply and activate the existing inactive policy. If `no`, it will deactivate the existing active policy. Generally should be `yes` only in cases where you want to activate new or existing policy. In TMOS v14 and later, deactivating the policy will cause it to be detached from any other associated objects, hence the default option of `no` has been removed in order to prevent accidental disassociation. \| \| apply boolean added in 1.4.0 of f5networks.f5\_modules \| Choices:* no * yes \| If `yes` will apply the policy if the policy has pending changes. This parameter supported on TMOS `v14.x` and above. \| \| name string / required \| \| The ASM policy to manage or create. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, and the `template` parameter is provided, a new ASM policy is created from the template with the given policy `name`. When `state` is `present` and no `template` parameter is provided, a new blank ASM policy is created with the given policy `name`. When `state` is `absent`, ensures the policy is removed, even if it is currently active. \| \| template string \| Choices:* ActiveSync v1.0 v2.0 (http) * ActiveSync v1.0 v2.0 (https) * Comprehensive * Drupal * Fundamental * Joomla * LotusDomino 6.5 (http) * LotusDomino 6.5 (https) * OWA Exchange 2003 (http) * OWA Exchange 2003 (https) * OWA Exchange 2003 with ActiveSync (http) * OWA Exchange 2003 with ActiveSync (https) * OWA Exchange 2007 (http) * OWA Exchange 2007 (https) * OWA Exchange 2007 with ActiveSync (http) * OWA Exchange 2007 with ActiveSync (https) * OWA Exchange 2010 (http) * OWA Exchange 2010 (https) * Oracle 10g Portal (http) * Oracle 10g Portal (https) * Oracle Applications 11i (http) * Oracle Applications 11i (https) * PeopleSoft Portal 9 (http) * PeopleSoft Portal 9 (https) * Rapid Deployment Policy * SAP NetWeaver 7 (http) * SAP NetWeaver 7 (https) * SharePoint 2003 (http) * SharePoint 2003 (https) * SharePoint 2007 (http) * SharePoint 2007 (https) * SharePoint 2010 (http) * SharePoint 2010 (https) * Vulnerability Assessment Baseline * Wordpress \| An ASM policy built-in template. If the template does not exist, an error is raised. Once the policy has been created, this value cannot change. The `Comprehensive`, `Drupal`, `Fundamental`, `Joomla`, `Vulnerability Assessment Baseline`, and `Wordpress` templates are only available on BIG-IP versions >= 13. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create ASM policy from template bigip_asm_policy: name: new_sharepoint_policy template: SharePoint 2007 (http) state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create blank ASM policy bigip_asm_policy: name: new_blank_policy state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create blank ASM policy and activate bigip_asm_policy: name: new_blank_policy active: yes state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Activate ASM policy bigip_asm_policy: name: inactive_policy active: yes state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Deactivate ASM policy bigip_asm_policy_manage: name: active_policy state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| active boolean \| changed \| Set when activating/deactivating an ASM policy. Sample: True \| \| apply boolean \| changed when target policy has changes pending \| Set when applying pending changes to an ASM policy. Sample: True \| \| name string \| changed \| Name of the ASM policy to be managed/created. Sample: Asm\_APP1\_Transparent \| \| state string \| changed \| Action performed on the target device. Sample: absent \| \| template string \| changed \| Name of the built-in ASM policy template. Sample: OWA Exchange 2007 (https) \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_device_license – Manage license installation and activation on BIG-IP devices f5networks.f5\_modules.bigip\_device\_license – Manage license installation and activation on BIG-IP devices ============================================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_license`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manage license installation and activation on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accept\_eula boolean \| Choices:* no ← * yes \| Declares whether you accept the BIG-IP EULA or not. By default, this value is `no`. You must specifically declare you have viewed and accepted the license. This module does not present you with the EULA, so it is incumbent on you to read it. The EULA can be found here; https://support.f5.com/csp/article/K12902. This parameter is not required when `state` is `absent` and will be ignored if it is provided. \| \| addon\_keys list / elements=string added in 1.2.0 of f5networks.f5\_modules \| \| The list of addon keys to use to in conjunction with the base license. This parameter will be ignored if no `license_key` is provided. This parameter is not required when `state` is `absent` and will be ignored if it is provided. \| \| force boolean \| Choices:* no ← * yes \| Declares whether to force license renewal. By default, this value is `no`. This parameter is not required and will be ignored if it is provided. \| \| license\_key string \| \| The registration key to use to license the BIG-IP. This parameter is required if the `state` is equal to `present` or `latest`. This parameter is not required when `state` is `absent` and will be ignored if it is provided. \| \| license\_server string \| Default:"activate.f5.com" \| The F5 license server to use when getting a license and validating a dossier. This parameter is required if the `state` is equal to `present` or `latest`. This parameter is not required when `state` is `absent` and will be ignored if it is provided. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* absent * latest * present ← * revoked \| The state of the license on the system. When `present`, only guarantees that a license exists. When `absent`, removes the license on the system. When `latest`, ensures that the license is always valid. This is not idempotent state since re-run can modify result. When `revoked`, removes the license on the system and revokes its future usage on the F5 license servers. \| Notes ----- Note * This module can be used to license BIG-IPs that do not have access to internet. * Only the Ansible Controller needs internet access as the license activation is done on the Ansible Controller from which the module is running. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: License BIG-IP using a key bigip_device_license: license_key: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX" provider: server: "lb.mydomain.com" user: "admin" password: "secret" delegate_to: localhost - name: License BIG-IP using a key bigip_device_license: license_key: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX" provider: server: "lb.mydomain.com" user: "admin" password: "secret" delegate_to: localhost - name: Remove the license from the system bigip_device_license: state: "absent" provider: server: "lb.mydomain.com" user: "admin" password: "secret" delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) * Andrey Kashcheev (@andreykashcheev) ansible f5networks.f5_modules.bigip_device_ntp – Manage NTP servers on a BIG-IP f5networks.f5\_modules.bigip\_device\_ntp – Manage NTP servers on a BIG-IP ========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_ntp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage NTP (Network Time Protocol) servers on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| ntp\_servers list / elements=string \| \| A list of NTP servers to set on the device. At least one of `ntp_servers` or `timezone` is required. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* absent * present ← \| The state of the NTP servers on the system. When `present`, guarantees the NTP servers are set on the system. When `absent`, removes the specified NTP servers from the device configuration. \| \| timezone string \| \| The timezone to set for NTP lookups. At least one of `ntp_servers` or `timezone` is required. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set NTP server bigip_device_ntp: ntp_servers: - 192.0.2.23 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set timezone bigip_device_ntp: timezone: America/Los_Angeles provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| ntp\_servers list / elements=string \| changed \| The NTP servers that were set on the device. Sample: ['192.0.2.23', '192.0.2.42'] \| \| timezone string \| changed \| The timezone that was set on the device. Sample: True \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_iapp_service – Manages TCL iApp services on a BIG-IP f5networks.f5\_modules.bigip\_iapp\_service – Manages TCL iApp services on a BIG-IP =================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_iapp_service`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages TCL iApp services on a BIG-IP. * The API the system uses to communicate with on the BIG-IP is `/mgmt/tm/sys/application/service/`. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the iApp service. If this option is specified in the Ansible task, it takes precedence over any similar setting in the iApp Service payload that you provide in the `parameters` field. \| \| device\_group string \| \| The device group for the iApp service. If this option is specified in the Ansible task, it takes precedence over any similar setting in the iApp Service payload that you provide in the `parameters` field. \| \| force boolean \| Choices:* no ← * yes \| Forces the updating of an iApp service, even if the parameters to the service have not changed. This option is of particular importance if the iApp template that underlies the service has been updated in-place. This option is equivalent to re-configuring the iApp if that template has changed. \| \| metadata list / elements=raw \| \| Metadata associated with the iApp service. If this option is specified in the Ansible task, it takes precedence over any similar setting in the iApp Service payload that you provide in the `parameters` field. \| \| name string / required \| \| The name of the iApp service you want to deploy. \| \| parameters dictionary \| \| A hash of all the required template variables for the iApp template. If your parameters are stored in a file (the more common scenario) we recommend you use either the `file` or `template` lookups to supply the expected parameters. These parameters typically consist of the `lists`, `tables`, and `variables` fields. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the iApp service is created and running. When `absent`, ensures the iApp service has been removed. \| \| strict\_updates boolean \| Choices:* no * yes \| Indicates whether the application service is tied to the template, so when the template is updated, the application service changes to reflect the updates. When `yes`, disallows any updates to the resources that the iApp service has created, if they are not updated directly through the iApp. When `no`, allows updates outside of the iApp. If this option is specified in the Ansible task, it takes precedence over any similar setting in the iApp Service payload that you provide in the `parameters` field. \| \| template string \| \| The iApp template from which to instantiate a new service. This template must exist on your BIG-IP before you can successfully create a service. When creating a new service, this parameter is required. \| \| traffic\_group string \| \| The traffic group for the iApp service. When creating a new service, if this value is not specified, the default of `/Common/traffic-group-1` is used. If this option is specified in the Ansible task, it takes precedence over any similar setting in the iApp Service payload that you provide in the `parameters` field. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create HTTP iApp service from iApp template bigip_iapp_service: name: foo-service template: f5.http parameters: "{{ lookup('file', 'f5.http.parameters.json') }}" state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Upgrade foo-service to v1.2.0rc4 of the f5.http template bigip_iapp_service: name: foo-service template: f5.http.v1.2.0rc4 state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Configure a service using parameters in YAML bigip_iapp_service: name: tests template: web_frontends state: present parameters: variables: - name: var__vs_address value: 1.1.1.1 - name: pm__apache_servers_for_http value: 2.2.2.1:80 - name: pm__apache_servers_for_https value: 2.2.2.2:80 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Re-configure a service whose underlying iApp was updated in place bigip_iapp_service: name: tests template: web_frontends force: yes state: present parameters: variables: - name: var__vs_address value: 1.1.1.1 - name: pm__apache_servers_for_http value: 2.2.2.1:80 - name: pm__apache_servers_for_https value: 2.2.2.2:80 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Try to remove the iApp template before the associated Service is removed bigip_iapp_template: name: web_frontends state: absent provider: user: admin password: secret server: lb.mydomain.com register: result failed_when: - result is not success - "'referenced by one or more applications' not in result.msg" - name: Configure a service using more complicated parameters bigip_iapp_service: name: tests template: web_frontends state: present provider: user: admin password: secret server: lb.mydomain.com parameters: variables: - name: var__vs_address value: 1.1.1.1 - name: pm__apache_servers_for_http value: 2.2.2.1:80 - name: pm__apache_servers_for_https value: 2.2.2.2:80 lists: - name: irules__irules value: - foo - bar tables: - name: basic__snatpool_members - name: net__snatpool_members - name: optimizations__hosts - name: pool__hosts columnNames: - name rows: - row: - internal.company.bar - name: pool__members columnNames: - addr - port - connection_limit rows: - row: - "none" - 80 - 0 - name: server_pools__servers delegate_to: localhost - name: Override metadata that may or may not exist in parameters bigip_iapp_service: name: foo-service template: f5.http parameters: "{{ lookup('file', 'f5.http.parameters.json') }}" metadata: - persist: yes name: data 1 - persist: yes name: data 2 state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_snmp – Manipulate general SNMP settings on a BIG-IP f5networks.f5\_modules.bigip\_snmp – Manipulate general SNMP settings on a BIG-IP ================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_snmp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manipulate general SNMP settings on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| agent\_authentication\_traps string \| Choices:* enabled * disabled \| When `enabled`, ensures the system sends authentication warning traps to the trap destinations. This is usually disabled by default on a BIG-IP. \| \| agent\_status\_traps string \| Choices:* enabled * disabled \| When `enabled`, ensures the system sends a trap whenever the SNMP agent starts running or stops running. This is usually enabled by default on a BIG-IP. \| \| allowed\_addresses raw \| \| Configures the IP addresses of the SNMP clients from which the snmpd daemon accepts requests. This value can be hostnames, IP addresses, or IP networks. You may specify a single list item of `default` to set the value back to the system default of `127.0.0.0/8`. You can remove all allowed addresses by either providing the word `none`, or by providing the empty string `""`. \| \| contact string \| \| Specifies the name of the person who administers the SNMP service for this system. \| \| device\_warning\_traps string \| Choices:* enabled * disabled \| When `enabled`, ensures the system sends device warning traps to the trap destinations. This is usually enabled by default on a BIG-IP. \| \| location string \| \| Specifies the description of this system's physical location. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set snmp contact bigip_snmp: contact: Joe User provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set snmp location bigip_snmp: location: US West 1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| agent\_authentication\_traps string \| changed \| Value of the authentication status traps. Sample: enabled \| \| agent\_status\_traps string \| changed \| Value of the agent status traps. Sample: enabled \| \| allowed\_addresses list / elements=string \| changed \| The new allowed addresses for SNMP client connections. Sample: ['127.0.0.0/8', 'foo.bar.com', '10.10.10.10'] \| \| contact string \| changed \| The new value for the person who administers SNMP on the device. Sample: Joe User \| \| device\_warning\_traps string \| changed \| Value of the warning status traps. Sample: enabled \| \| location string \| changed \| The new value for the system's physical location. Sample: US West 1a \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigiq_regkey_license_assignment – Manage regkey license assignment on BIG-IPs from a BIG-IQ f5networks.f5\_modules.bigiq\_regkey\_license\_assignment – Manage regkey license assignment on BIG-IPs from a BIG-IQ ===================================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_regkey_license_assignment`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages the assignment of regkey licenses on a BIG-IQ. Assignment means the license is assigned to a BIG-IP, or it needs to be assigned to a BIG-IP. Additionally, this module supports revoking the assignments from BIG-IP devices. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| device string / required \| \| When `managed` is `no`, specifies the address, or hostname, where the BIG-IQ can reach the remote device to register. When `managed` is `yes`, specifies the managed device, or device UUID, that you want to register. If `managed` is `yes`, it is very important you do not have more than one device with the same name. BIG-IQ internally recognizes devices by their ID, and therefore, this module cannot guarantee the correct device will be registered. The device returned is the device that is used. \| \| device\_password string \| \| The password of the `device_username`. When `managed` is `no`, this parameter is required. \| \| device\_port integer \| Default:443 \| Specifies the port of the remote device to connect to. If this parameter is not specified, the default is `443`. \| \| device\_username string \| \| The username used to connect to the remote device. This username should be one that has sufficient privileges on the remote device to do licensing. Usually this is the `Administrator` role. When `managed` is `no`, this parameter is required. \| \| key string / required \| \| The registration key you want to assign from the pool. \| \| managed boolean \| Choices:* no * yes \| Whether the specified device is a managed or un-managed device. When `state` is `present`, this parameter is required. \| \| pool string / required \| \| The registration key pool to use. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the device is assigned the specified license. When `absent`, ensures the license is revoked from the remote device and freed on the BIG-IQ. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Register an unmanaged device bigiq_regkey_license_assignment: pool: my-regkey-pool key: XXXX-XXXX-XXXX-XXXX-XXXX device: 1.1.1.1 managed: no device_username: admin device_password: secret state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Register a managed device, by name bigiq_regkey_license_assignment: pool: my-regkey-pool key: XXXX-XXXX-XXXX-XXXX-XXXX device: bigi1.foo.com managed: yes state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Register a managed device, by UUID bigiq_regkey_license_assignment: pool: my-regkey-pool key: XXXX-XXXX-XXXX-XXXX-XXXX device: 7141a063-7cf8-423f-9829-9d40599fa3e0 managed: yes state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_device_ha_group – Manage HA group settings on a BIG-IP system f5networks.f5\_modules.bigip\_device\_ha\_group – Manage HA group settings on a BIG-IP system ============================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_ha_group`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage HA (High Availability) group settings on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| active\_bonus integer \| \| Specifies the extra value to be added to the HA score of the active unit. When system creates HA group this value is set to `10` by the system. \| \| description string \| \| User created HA group description. \| \| enable boolean \| Choices:* no * yes ← \| When set to `no`, the system disables the HA score feature. \| \| name string / required \| \| Name of the HA group to create/manage. \| \| pools list / elements=dictionary \| \| Specifies pools to contribute to the HA score. The pools must exist on the BIG-IP, otherwise the operation will fail. \| \| \| attribute string \| Choices:* percent-up-members ← \| The pool attribute that contributes to the HA score. \| \| \| minimum\_threshold integer \| \| Below this value, the selected pool attribute contributes nothing to the HA score. This value must be greater than the number of pool members present in the pool. In TMOS versions 12.x this attribute is named `threshold`, however it has been deprecated in versions 13.x and above. Specifying this attribute in the module running against v12.x will keep the same behavior as if `threshold` option was set. \| \| \| partition string \| Default:"Common" \| Device partition where the specified pool exists. This parameter is ignored if the `pool_name` is specified in full path format. \| \| \| pool\_name string / required \| \| The pool name which is used to contribute to the HA score. Referencing the pool can be done in the full path format for example, `/Common/pool_name`. When the pool is referenced in full path format, the `partition` parameter is ignored. \| \| \| weight integer / required \| \| Maximum value the selected pool attribute contributes to the HA score. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| trunks list / elements=dictionary \| \| Specifies trunks to contribute to the HA score. The trunks must exist on the BIG-IP, otherwise the operation will fail. \| \| \| attribute string \| Choices:* percent-up-members ← \| The trunk attribute that contributes to the HA score. \| \| \| minimum\_threshold integer \| \| Below this value the selected trunk attribute contributes nothing to the HA score. This value must be greater than the number of trunk members. In TMOS versions 12.x this attribute is named `threshold`, however it has been deprecated in versions 13.x and above. Specifying this attribute in the module running against v12.x will keep the same behavior as if `threshold` option was set. \| \| \| trunk\_name string / required \| \| The trunk name used to contribute to the HA score. \| \| \| weight integer / required \| \| Maximum value the selected trunk attribute contributes to the HA score. \| Notes ----- Note * This module does not support atomic removal of HA group objects. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create HA group no members, not active bigip_device_ha_group: name: foo_ha description: empty_foo active_bonus: 20 enable: no provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create HA group with pools and trunks bigip_device_ha_group: name: baz_ha description: non_empty_baz active_bonus: 15 pools: - pool_name: foopool weight: 30 minimum_threshold: 1 trunks: - trunk_name: footrunk weight: 70 minimum_threshold: 2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create HA group pools using full_path format bigip_device_ha_group: name: bar_ha description: non_empty_bar active_bonus: 12 pools: - pool_name: /Baz/foopool weight: 30 minimum_threshold: 1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove HA group bigip_device_ha_group: name: foo_ha state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| active\_bonus integer \| changed \| The extra value to be added to the HA score of the active unit. Sample: 20 \| \| description string \| changed \| User created HA group description. Sample: Some Group \| \| enable boolean \| changed \| Enables or disables the HA score feature. Sample: True \| \| name string \| changed \| Name of the HA group. Sample: foo\_HA \| \| pools complex \| changed \| The pools to contribute to the HA score. Sample: hash/dictionary of values \| \| \| attribute string \| changed \| The pool attribute that contributes to the HA score. Sample: percent-up-members \| \| \| minimum\_threshold integer \| changed \| Below this value the selected pool attribute contributes nothing to the HA score. Sample: 2 \| \| \| partition string \| changed \| Device partition where the specified pool exists. Sample: Common \| \| \| pool\_name string \| changed \| The pool name which is used to contribute to the HA score. Sample: foo\_pool \| \| \| weight integer \| changed \| Maximum value the selected pool attribute contributes to the HA score. Sample: 40 \| \| trunks complex \| changed \| The trunks to contribute to the HA score. Sample: hash/dictionary of values \| \| \| attribute string \| changed \| The trunk attribute that contributes to the HA score. Sample: percent-up-members \| \| \| minimum\_threshold integer \| changed \| Below this value, the selected trunk attribute contributes nothing to the HA score. Sample: 2 \| \| \| trunk\_name string \| changed \| The trunk name used to contribute to the HA score. Sample: foo\_trunk \| \| \| weight integer \| changed \| Maximum value the selected trunk attribute contributes to the HA score. Sample: 40 \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_data_group – Manage data groups on a BIG-IP f5networks.f5\_modules.bigip\_data\_group – Manage data groups on a BIG-IP ========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_data_group`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Allows for managing data groups on a BIG-IP. Data groups provide a way to store collections of values on a BIG-IP for later use in things such as LTM rules, iRules, and ASM policies. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| delete\_data\_group\_file boolean \| Choices:* no ← * yes \| When `yes`, ensures the remote data group file is deleted. This parameter is only relevant when `state` is `absent` and `internal` is `no`. \| \| description string \| \| The description of the data group. \| \| external\_file\_name string \| \| When creating a new data group, this specifies the file name you want to give an external data group file on the BIG-IP. This parameter is ignored when `internal` is `yes`. This parameter can be used to select an existing data group file to use with an existing external data group. If this value is not provided, it will be given the value specified in `name` and, therefore, match the name of the data group. This value may only contain letters, numbers, underscores, dashes, or a period. \| \| internal boolean \| Choices:* no ← * yes \| The type of this data group. You should only consider setting this value in cases where you know exactly what you are doing, or, you are working with a pre-existing internal data group. Be aware that if you deliberately force this parameter to `yes`, and you have a either a large number of records or a large total records size, this large amount of data will be reflected in your BIG-IP configuration. This can lead to long system configuration load times due to parsing and verifying the large configuration. There is a limit of either 4 megabytes or 65,000 records (whichever is more restrictive) for uploads when this parameter is `yes`. This value cannot be changed once the data group is created. \| \| name string / required \| \| Specifies the name of the data group. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| records list / elements=raw \| \| Specifies the records you want to add to a data group. If you have a large number of records, we recommend you use `records_src` instead of typing all those records here. The technical limit of either the number of records, or the total size of all records. Varies with the size of the total resources on your system; in particular, RAM. When `internal` is `no`, at least one record must be specified in either `records` or `records_src`. When `type` is: `ip`, `address`, `addr` if the addresses use a non-default route domain, they must be explicit about it, meaning they must contain a route domain notation `%` e.g. 10.10.1.1%11. This is true regardless if the data group resides in a partition or not. \| \| \| key string / required \| \| The key describing the record in the data group. The key will be used for validation of the `type` parameter to this module. \| \| \| value raw \| \| The value of the key describing the record in the data group. \| \| records\_src path \| \| Path to a file with records in it. The file should be well-formed. This means it includes records, one per line, that resemble the following format "key separator value". For example, `foo := bar`. BIG-IP is strict about this format, but this module is a bit more lax. It will allow you to include arbitrary amounts (including none) of empty space on either side of the separator. For an illustration of this, see the Examples section. Record keys are limited in length to no more than 65520 characters. Values of record keys are limited in length to no more than 65520 characters. The total number of records you can have in your BIG-IP is limited by the memory of the BIG-IP itself. The format of this content is slightly different depending on whether you specify a `type` of `address`, `integer`, or `string`. See the examples section for examples of the different types of payload formats that are expected in your data group file. When `internal` is `no`, at least one record must be specified in either `records` or `records_src`. \| \| separator string \| Default:":=" \| When specifying `records_src`, this is the string of characters that will be used to break apart entries in the `records_src` into key/value pairs. By default, the value of this parameter is `:=`. This value cannot be changed once it is set. This parameter is only relevant when `internal` is `no`. It will be ignored otherwise. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the data group exists. When `state` is `absent`, ensures the data group is removed. The use of state in this module refers to the entire data group, not its members. \| \| type string \| Choices:* address * addr * ip * string ← * integer * int \| The type of records in this data group. This parameter is important because it causes the BIG-IP to store your data in different ways to optimize access to it. For example, it would be wrong to specify a list of records containing IP addresses, but label them as a `string` type. This value cannot be changed once the data group is created. \| Notes ----- Note * This module does NOT support atomic updates of data group members in a type `internal` data group. * Addition/Deletion of data group members in a type `external` data group should be done through Ansible modules only, if changes are made manually, the Ansible module will not detect those changes. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a data group of addresses bigip_data_group: name: foo internal: yes records: - key: 0.0.0.0/32 value: External_NAT - key: 10.10.10.10 value: No_NAT type: address provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a data group of strings bigip_data_group: name: foo internal: yes records: - key: caddy value: "" - key: cafeteria value: "" - key: cactus value: "" type: string provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a data group of IP addresses from a file bigip_data_group: name: foo records_src: /path/to/dg-file type: address provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update an existing internal data group of strings bigip_data_group: name: foo internal: yes records: - key: caddy value: "" - key: cafeteria value: "" - key: cactus value: "" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Show the data format expected for records_content - address 1 copy: dest: /path/to/addresses.txt content: \| network 10.0.0.0 prefixlen 8 := "Network1", network 172.16.0.0 prefixlen 12 := "Network2", network 192.168.0.0 prefixlen 16 := "Network3", network 2402:9400:1000:0:: prefixlen 64 := "Network4", host 192.168.20.1 := "Host1", host 172.16.1.1 := "Host2", host 172.16.1.1 := "Host3", host 2001:0db8:85a3:0000:0000:8a2e:0370:7334 := "Host4", host 2001:0db8:85a3:0000:0000:8a2e:0370:7334 := "Host5" - name: Show the data format expected for records_content - address 2 copy: dest: /path/to/addresses.txt content: \| 10.0.0.0/8 := "Network1", 172.16.0.0/12 := "Network2", 192.168.0.0/16 := "Network3", 2402:9400:1000:0::/64 := "Network4", 192.168.20.1 := "Host1", 172.16.1.1 := "Host2", 172.16.1.1/32 := "Host3", 2001:0db8:85a3:0000:0000:8a2e:0370:7334 := "Host4", 2001:0db8:85a3:0000:0000:8a2e:0370:7334/128 := "Host5" - name: Show the data format expected for records_content - string copy: dest: /path/to/strings.txt content: \| a := alpha, b := bravo, c := charlie, x := x-ray, y := yankee, z := zulu, - name: Show the data format expected for records_content - integer copy: dest: /path/to/integers.txt content: \| 1 := bar, 2 := baz, 3, 4, ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) * Greg Crosby (@crosbygw)	programming_docs
ansible f5networks.f5_modules.bigip_gtm_global – Manages global GTM settings f5networks.f5\_modules.bigip\_gtm\_global – Manages global GTM settings ======================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_global`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages global BIG-IP GTM (now BIG-IP DNS) settings. These settings include general, load balancing, and metrics related settings. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| synchronization boolean \| Choices:* no * yes \| Specifies whether this system is a member of a synchronization group. When you enable synchronization, the system periodically queries other systems in the synchronization group to obtain and distribute configuration and metrics collection updates. The synchronization group may contain systems configured as Global Traffic Manager (DNS) and Link Controller systems. \| \| synchronization\_group\_name string \| \| Specifies the name of the synchronization group to which the system belongs. \| \| synchronize\_zone\_files boolean \| Choices:* no * yes \| Specifies the system synchronizes Domain Name System (DNS) zone files among the synchronization group members. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Configure synchronization settings bigip_gtm_global: synchronization: yes synchronization_group_name: my-group synchronize_zone_files: yes state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| synchronization boolean \| changed \| The synchronization setting on the system. Sample: True \| \| synchronization\_group\_name string \| changed \| The synchronization group name. Sample: my-group \| \| synchronize\_zone\_files string \| changed \| Whether or not the system will synchronize zone files. Sample: my-group \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_monitor_https – Manages F5 BIG-IP LTM HTTPS monitors f5networks.f5\_modules.bigip\_monitor\_https – Manages F5 BIG-IP LTM HTTPS monitors =================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_https`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM HTTPS monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cipher\_list string added in 1.3.0 of f5networks.f5\_modules \| \| Specifies the list of ciphers for this monitor. The items in the cipher list are separated with a colon `:`. \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template runs. If this parameter is not provided when creating a new monitor, the default value is 5. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/https" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `https` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must specify a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| receive string \| \| The Receive string for the monitor call. \| \| receive\_disable string \| \| This setting works like `receive`, except the system marks the node or pool member disabled when its response matches the `receive_disable` string but not `receive`. To use this setting, you must specify both `receive_disable` and `receive`. \| \| reverse boolean added in 1.12.0 of f5networks.f5\_modules \| Choices:* no * yes \| Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up. You can use the this mode only if you configure the `receive` option. This parameter is not compatible with the `time_until_up` parameter. If `time_until_up` is specified, it must be `0`. Or, if it already exists, it must be `0`. \| \| send string \| \| The Send string for the monitor call. When creating a new monitor, if this value is not provided, the default `GET /\\r\\n` is used. \| \| ssl\_profile string \| \| Specifies the SSL profile to use for the HTTPS monitor. Defining SSL profiles enables refined customization of the SSL attributes for an HTTPS monitor. This parameter is only supported on BIG-IP versions 13.x and later. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password, if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name, if the monitored target requires authentication. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node is marked up. A value of 0 causes a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, then the default value is 0. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value is 16. \| \| up\_interval integer \| \| Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval when checking the health of a resource that is up. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create HTTPS Monitor bigip_monitor_https: name: my_http_monitor state: present ip: 10.10.10.10 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove HTTPS Monitor bigip_monitor_https: name: my_http_monitor state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cipher\_list string \| changed \| The new value for the cipher list. Sample: +3DES:+kEDH \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: https \| \| reverse boolean \| changed \| Whether the monitor operates in reverse mode. Sample: True \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| up\_interval integer \| changed \| Interval for the system to use to perform the health check when a resource is up. \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_gtm_monitor_https – Manages F5 BIG-IP GTM HTTPS monitors f5networks.f5\_modules.bigip\_gtm\_monitor\_https – Manages F5 BIG-IP GTM HTTPS monitors ======================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_monitor_https`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP GTM (now BIG-IP DNS) HTTPS monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cipher\_list string \| \| Specifies the list of ciphers for this monitor. The items in the cipher list are separated with the colon `:` symbol. When creating a new monitor, if this parameter is not specified, the default list is `DEFAULT:+SHA:+3DES:+kEDH`. \| \| client\_cert string \| \| Specifies a fully-qualified path for a client certificate the monitor sends to the target SSL server. \| \| client\_key string \| \| Specifies a key for a client certificate the monitor sends to the target SSL server. \| \| compatibility boolean \| Choices:* no * yes \| Specifies, when enabled, the SSL options setting (in OpenSSL) is set to all. When creating a new monitor, if this value is not specified, the default is `yes` \| \| ignore\_down\_response boolean \| Choices:* no * yes \| Specifies the monitor allows more than one probe attempt per interval. When `yes`, specifies the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down. When `no`, specifies the monitor immediately marks an object down when it receives a down response. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value will be 30. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. If this value is an IP address, a `port` number must be specified. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/https" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `https` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. If specifying an IP address, you must specify a value between 1 and 65535. \| \| probe\_timeout* integer \| \| Specifies the number of seconds after which the system times out the probe request to the system. When creating a new monitor, if this parameter is not provided, then the default value will be `5`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| receive string \| \| The receive string for the monitor call. \| \| reverse boolean \| Choices:* no * yes \| Instructs the system to mark the target resource down when the test is successful. This setting is useful, for example, if the content on your web site home page is dynamic and changes frequently, you may want to set up a reverse ECV service check that looks for the string Error. A match for this string means the web server was down. To use this option, you must specify values for `send` and `receive`. \| \| send string \| \| The send string for the monitor call. When creating a new monitor, if this parameter is not provided, the default of `GET /\r\n` will be used. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password, if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name, if the monitored target requires authentication. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value will be 120. \| \| transparent boolean \| Choices:* no * yes \| Specifies whether the monitor operates in transparent mode. A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the `ip`-`port` combination specified in the monitor). If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will update passwords if the `target_password` is specified. `on_create` will only set the password for newly created monitors. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a GTM HTTPS monitor bigip_gtm_monitor_https: name: my_monitor ip: 1.1.1.1 port: 80 send: my send string receive: my receive string state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove HTTPS Monitor bigip_gtm_monitor_https: name: my_monitor state: absent provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add HTTPS monitor for all addresses, port 514 bigip_gtm_monitor_https: name: my_monitor provider: user: admin password: secret server: lb.mydomain.com port: 514 delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cipher\_list string \| changed \| The new value for the cipher list. Sample: +3DES:+kEDH \| \| client\_cert string \| changed \| The new client cert setting. Sample: /Common/default \| \| client\_key string \| changed \| The new client key setting. Sample: /Common/default \| \| compatibility boolean \| changed \| The new SSL compatibility setting. Sample: True \| \| ignore\_down\_response boolean \| changed \| Whether to ignore the down response or not. Sample: True \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: https \| \| port string \| changed \| The new port the monitor checks the resource on. Sample: 8080 \| \| probe\_timeout integer \| changed \| The new timeout in which the system will timeout the monitor probe. Sample: 10 \| \| receive string \| changed \| The new receive string for this monitor. Sample: tcp string to receive \| \| reverse boolean \| changed \| The new value for whether the monitor operates in reverse mode. \| \| send string \| changed \| The new send string for this monitor. Sample: tcp string to send \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| transparent boolean \| changed \| The new value for whether the monitor operates in transparent mode. \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_log_publisher – Manages log publishers on a BIG-IP f5networks.f5\_modules.bigip\_log\_publisher – Manages log publishers on a BIG-IP ================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_log_publisher`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages log publishers on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Specifies a description for the log publisher. \| \| destinations list / elements=string \| \| Specifies log destinations for this log publisher to use. \| \| name string / required \| \| Specifies the name of the log publisher. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a log publisher for use in high speed loggins bigip_log_publisher: name: publisher1 destinations: - hsl1 - security-log-servers-logging state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the resource. Sample: Security log publisher \| \| destinations list / elements=string \| changed \| The new list of destinations for the resource. Sample: ['/Common/destination1', '/Common/destination2'] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigiq_device_discovery – Manage BIG-IP devices through BIG-IQ f5networks.f5\_modules.bigiq\_device\_discovery – Manage BIG-IP devices through BIG-IQ ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_device_discovery`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Discovers and imports BIG-IP device configuration on the BIG-IQ. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| access\_conflict\_policy string \| Choices:* use\_bigiq * use\_bigip * keep\_version \| Sets the conflict resolution policy for Access module `apm` objects. Only used when the `apm` module is specified. \| \| access\_group\_first\_device boolean \| Choices:* no * yes ← \| Specifies if the imported device is the first device in the access group to import shared configuration for that access group. \| \| access\_group\_name string \| \| Access group name to import Access configuration for devices. Once set it cannot be changed. \| \| conflict\_policy string \| Choices:* use\_bigiq ← * use\_bigip \| Sets the conflict resolution policy for shared objects across BIG-IP devices, except LTM profiles and monitors. \| \| device\_address string / required \| \| The IP address of the BIG-IP device to be imported/managed. \| \| device\_conflict\_policy string \| Choices:* use\_bigiq ← * use\_bigip \| Sets the conflict resolution policy for objects that are specific to a particular to a BIG-IP device and not shared among BIG-IP devices. \| \| device\_password string \| \| The administrator password for the BIG-IP device. This parameter is only required when adding a new BIG-IP device to be managed. \| \| device\_port integer \| Default:443 \| The port on which a device trust setup between BIG-IQ and BIG-IP should happen. \| \| device\_username string \| \| The administrator username for the BIG-IP device. This parameter is only required when adding a new BIG-IP device to be managed. \| \| force boolean \| Choices:* no ← * yes \| Forces rediscovery and import of existing modules on the managed BIG-IP. \| \| ha\_name string \| \| DSC cluster name of the BIG-IP device to be managed. This is optional if the managed device is not a part of a cluster group. When `use_bigiq_sync` is set to `yes`, this parameter is required. \| \| modules list / elements=string \| Choices:* ltm * asm * apm * afm * dns * websafe * security\_shared \| List of modules to be discovered and imported into the device. These modules must be provisioned on the target device, otherwise operation will fail. The `ltm` module must always be specified when performing discovery or re-discovery of the the device. When `asm` or `afm` are specified, the `shared_security` module also needs to be declared. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* absent * present ← \| The state of the managed device on the system. When `present`, enables new device addition as well as device rediscovery/import. When `absent`, completely removes the device from the system. \| \| statistics dictionary \| \| Specify the statistics collection for discovered device. \| \| \| enable boolean \| Choices:* no ← * yes \| Enables statistics collection on a device. \| \| \| interval integer \| Choices:* 30 * 60 * 120 * 500 Default:60 \| Specifies the interval the data is collected from the discovered device, in seconds. \| \| \| stat\_modules list / elements=string \| Choices:* device ← * ltm ← * dns Default:["device", "ltm"] \| Specifies for which modules the data is being collected. \| \| \| zone string \| Default:"default" \| Specifies in which DCD zone is collecting the data from device. \| \| use\_bigiq\_sync boolean \| Choices:* no ← * yes \| When set to true, BIG-IQ manually synchronizes configuration changes between members in a DSC cluster. \| \| versioned\_conflict\_policy string \| Choices:* use\_bigiq * use\_bigip * keep\_version \| Sets the conflict resolution policy for LTM profile and monitor objects that are specific to a BIG-IP software version. \| Notes ----- Note * BIG-IQ >= 6.1.0. * This module does not support atomic removal of discovered modules on the device. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Discover a new device and import config, use default conflict policy. bigiq_device_discovery: device_address: 192.168.1.1 device_username: bigipadmin device_password: bigipsecret modules: - ltm - afm - shared_security provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Discover a new device and import config, use non- default conflict policy. bigiq_device_discovery: device_address: 192.168.1.1 modules: - ltm - dns conflict_policy: use_bigip provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Force full device rediscovery bigiq_device_discovery: device_address: 192.168.1.1 modules: - ltm - afm - dns - shared_security force: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove discovered device and its config bigiq_device_discovery: device_address: 192.168.1.1 state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| access\_conflict\_policy string \| changed \| Sets the conflict resolution policy for Access module `apm` objects. Sample: keep\_version \| \| access\_group\_first\_device boolean \| changed \| First device in the access group to import shared configuration for that access group. Sample: True \| \| access\_group\_name string \| changed \| Access group name to import Access configuration for devices. Sample: foo\_group \| \| conflict\_policy string \| changed \| Sets the conflict resolution policy for shared objects across BIG-IP devices. Sample: use\_bigip \| \| device\_address string \| changed \| The IP address of the BIG-IP device to be imported/managed. Sample: 192.168.1.1 \| \| device\_conflict\_policy string \| changed \| Sets the conflict resolution policy for objects that are specific to a particular to a BIG-IP device. Sample: use\_bigip \| \| device\_port integer \| changed \| The port on which a device trust setup between BIG-IQ and BIG-IP should happen. Sample: 10443 \| \| ha\_name string \| changed \| DSC cluster name of the BIG-IP device to be managed. Sample: GROUP\_1 \| \| modules list / elements=string \| changed \| List of modules to be discovered and imported into the device. Sample: ['ltm', 'dns'] \| \| use\_bigiq\_sync boolean \| changed \| Indicates if BIG-IQ should manually synchronize DSC configuration. Sample: True \| \| versioned\_conflict\_policy string \| changed \| Sets the conflict resolution policy for LTM profile and monitor objects. Sample: keep\_version \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_provision – Manage BIG-IP module provisioning f5networks.f5\_modules.bigip\_provision – Manage BIG-IP module provisioning =========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_provision`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP module provisioning. This module will only provision at the standard levels of Dedicated, Nominal, and Minimum. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| level string \| Choices:* dedicated * nominal ← * minimum \| Sets the provisioning level for the requested modules. Changing the level for one module may require modifying the level of another module. For example, changing one module to `dedicated` requires setting all others to `none`. Setting the level of a module to `none` means the module is not activated. Use a `state` of absent to set c(level) to none and de-provision the module. This parameter is not relevant to `cgnat - pre tmos 15.0` or `mgmt` and will not be applied to the `cgnat - pre tmos 15.0` or `mgmt` module. \| \| memory string \| \| Sets additional memory for the management module. This is in addition to minimum allocated RAM of 1264MB. The accepted value range is `0 - 8192`. Maximum value is restricted by the available RAM in the system. Specifying `large` reserves an additional 500MB for the mgmt module. Specifying `medium` reserves an additional 200MB for the mgmt module. Specifying `small` reserves no additional RAM for the mgmt module. Use `large` for configurations containing more than 2000 objects, or more specifically, for any configuration that exceeds 1000 objects per 2 GB of installed memory. Changing the Management `mgmt` size after initial provisioning causes a reprovision operation. \| \| module string / required \| Choices:* am * afm * apm * asm * avr * cgnat * fps * gtm * ilx * lc * ltm * mgmt * pem * sam * sslo * swg * urldb * vcmp \| The module to provision in BIG-IP. aliases: name \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| The state of the provisioned module on the system. When `present`, guarantees the specified module is provisioned at the requested level, provided there are sufficient resources on the device (such as physical RAM) to support the module. When `absent`, de-provision the module. `absent`, is not a relevent option for the `mgmt` module, as it can not be de-provisioned. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Provision PEM at "nominal" level bigip_provision: module: pem level: nominal provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost - name: Provision a dedicated SWG. This will unprovision every other module bigip_provision: module: swg level: dedicated provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost - name: Provision mgmt with medium amount of memory. bigip_provision: module: mgmt memory: medium provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| level string \| changed \| The new provisioning level of the module. Sample: minimum \| \| memory string \| changed \| The new provisioned amount of memory for mgmt module. Sample: large \| ### Authors * Tim Rupp (@caphrim007) * Greg Crosby (@crosbygw)	programming_docs
ansible f5networks.f5_modules.bigip_dns_resolver – Manage DNS resolvers on a BIG-IP f5networks.f5\_modules.bigip\_dns\_resolver – Manage DNS resolvers on a BIG-IP ============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_dns_resolver`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage DNS resolvers on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| answer\_default\_zones boolean \| Choices:* no * yes \| Specifies whether the system answers DNS queries for the default zones localhost, reverse 127.0.0.1 and ::1, and AS112. When creating a new resolver, if this parameter is not specified, the default is `no`, meaning the system passes along the DNS queries for the default zones. \| \| cache\_size integer \| \| Specifies the size of the internal DNS resolver cache. When creating a new resolver, if this parameter is not specified, the default is 5767168 bytes. After the cache reaches this size, when new or refreshed content arrives, the system removes expired and older content and caches the new or updated content. \| \| name string / required \| \| Specifies the name of the DNS resolver. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| randomize\_query\_case boolean \| Choices:* no * yes \| When `yes`, specifies the internal DNS resolver randomizes character case in domain name queries issued to the root DNS servers. When creating a new resolver, if this parameter is not specified, the default is `yes`. \| \| route\_domain integer \| \| Specifies the route domain the resolver uses for outbound traffic. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| use\_ipv4 boolean \| Choices:* no * yes \| Specifies whether the system can use IPv4 to query backend nameservers. An IPv4 Self IP and default route must be available for these queries to work successfully. When creating a new resolver, if this parameter is not specified, the default is `yes`. \| \| use\_ipv6 boolean \| Choices:* no * yes \| Specifies whether the system can use IPv6 to query backend nameservers. An IPv6 Self IP and default route must be available for these queries to work successfully. When creating a new resolver, if this parameter is not specified, the default is `yes`. \| \| use\_tcp boolean \| Choices:* no * yes \| Specifies whether the system answers and issues TCP-formatted queries. When creating a new resolver, if this parameter is not specified, the default is `yes`. \| \| use\_udp boolean \| Choices:* no * yes \| Specifies whether the system answers and issues UDP-formatted queries. When creating a new resolver, if this parameter is not specified, the default is `yes`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a simple DNS responder for OCSP stapling bigip_dns_resolver: name: resolver1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| answer\_default\_zones boolean \| changed \| The new Answer Default Zones setting. Sample: True \| \| cache\_size integer \| changed \| The new cache size of the resource. Sample: 50000 \| \| randomize\_query\_case boolean \| changed \| The new Randomize Query Character Case setting. \| \| route\_domain string \| changed \| The new route domain of the resource. Sample: /Common/0 \| \| use\_ipv4 boolean \| changed \| The new Use IPv4 setting. Sample: True \| \| use\_ipv6 boolean \| changed \| The new Use IPv6 setting. \| \| use\_tcp boolean \| changed \| The new Use TCP setting. \| \| use\_udp boolean \| changed \| The new Use UDP setting. Sample: True \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_apm_network_access – Manage APM Network Access resource f5networks.f5\_modules.bigip\_apm\_network\_access – Manage APM Network Access resource ======================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_apm_network_access`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage APM Network Access resource. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allow\_local\_dns boolean \| Choices:* no * yes \| Enables local access to DNS servers configured on the client prior to establishing a network access connection. \| \| allow\_local\_subnet boolean \| Choices:* no * yes \| Enables local subnet access and local access to any host or subnet in routes specified in the client routing table. When `yes` the system does not support integrated IP filtering. \| \| description string \| \| User created network access description. \| \| dns\_address\_space list / elements=string \| \| Specifies a list of domain names describing the target LAN DNS addresses. \| \| dtls boolean \| Choices:* no * yes \| When `yes` the network access connection uses Datagram Transport Level Security instead of TCP, to provide better throughput for high demand applications like VoIP or streaming video. \| \| dtls\_port integer \| \| Specifies the port number the network access resource uses for secure UDP traffic with DTLS. \| \| excluded\_dns\_addresses list / elements=string \| \| Specifies the DNS address spaces for which traffic is not forced through the tunnel. \| \| excluded\_ipv4\_adresses list / elements=dictionary \| \| Specifies IPV4 address spaces for which traffic is not forced through the tunnel. \| \| \| subnet string \| \| The address of subnet in CIDR format, e.g. `192.168.1.0/24` Host addresses can be specified without the CIDR mask notation. \| \| excluded\_ipv6\_adresses list / elements=dictionary \| \| Specifies IPV6 address spaces for which traffic is not forced through the tunnel. \| \| \| subnet string \| \| The address of a subnet in CIDR format, e.g. `2001:db8:abcd:8000::/52` Host addresses can be specified without the CIDR mask notation. \| \| ip\_version string \| Choices:* ipv4 * ipv4-ipv6 \| Supported IP version on the network access resource. \| \| ipv4\_address\_space list / elements=dictionary \| \| Specifies a list of IPv4 hosts or networks describing the target LAN. This option is mandatory when creating a new resource and `split_tunnel` is set to `yes`. \| \| \| subnet string \| \| The address of subnet in CIDR format, e.g. `192.168.1.0/24` Host addresses can be specified without the CIDR mask notation. \| \| ipv4\_lease\_pool string \| \| Specifies the IPV4 lease pool resource to use with network access. Referencing a lease pool can be done in the full path format, for example `/Common/pool_name`. When a lease pool is referenced in full path format, the `partition` parameter is ignored. \| \| ipv6\_address\_space list / elements=dictionary \| \| Specifies a list of IPv6 hosts or networks describing the target LAN. This option is mandatory when creating a new resource and `split_tunnel` is set to `yes`. \| \| \| subnet string \| \| The address of subnet in CIDR format, e.g. `2001:db8:abcd:8000::/52` Host addresses can be specified without the CIDR mask notation. \| \| ipv6\_lease\_pool string \| \| Specifies the IPV6 lease pool resource to use with network access. Referencing a lease pool can be done in the full path format, for example `/Common/pool_name`. When a lease pool is referenced in full path format, the `partition` parameter is ignored. \| \| name string / required \| \| Specifies the name of the APM network access to manage/create. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| snat\_pool string \| \| Specifies the name of a SNAT pool used for implementing selective and intelligent SNATs. When `none` the system uses no SNAT pool for this network resource. When `automap` the system uses all of the self IP addresses as the translation addresses for the pool. \| \| split\_tunnel boolean \| Choices:* no * yes \| Specifies that only the traffic targeted to a specified address space is sent over the network access tunnel. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the ACL exists. When `state` is `absent`, ensures the ACL is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a split tunnel IPV4 Network Access bigip_apm_network_access: name: foobar ip_version: ipv4 split_tunnel: yes snat_pool: "none" ipv4_lease_pool: leasefoo ipv4_address_space: - subnet: 10.10.1.1 - subnet: 10.10.2.0/24 excluded_ipv4_adresses: - subnet: 192.168.1.0/24 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify a split tunnel IPV4 Network Access bigip_apm_network_access: name: foobar snat_pool: /Common/poolsnat ipv4_address_space: - subnet: 172.16.23.0/24 excluded_ipv4_adresses: - subnet: 10.10.2.0/24 allow_local_subnet: yes allow_local_dns: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove Network Access bigip_apm_network_access: name: foobar state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| allow\_local\_dns boolean \| changed \| Enables local access to DNS servers configured on the client. Sample: True \| \| allow\_local\_subnet boolean \| changed \| Enables local subnet access. Sample: True \| \| description string \| changed \| The new description of Network Access. Sample: My Access \| \| dns\_address\_space list / elements=string \| changed \| Specifies a list of domain names describing the target LAN DNS addresses. Sample: ['internal.net', '\.engnet.org'] \| \| dtls* boolean \| changed \| Enables use of DTLS by network access. \| \| dtls\_port integer \| changed \| Specifies the port number the network access resource uses for DTLS. Sample: 4433 \| \| excluded\_dns\_addresses list / elements=string \| changed \| Specifies the DNS address spaces for which traffic is not forced through the tunnel. Sample: ['foobar.com', 'bazbar.org'] \| \| excluded\_ipv4\_adresses complex \| changed \| Specifies IPV4 address spaces for which traffic is not forced through the tunnel. Sample: hash/dictionary of values \| \| \| subnet string \| changed \| The host or network address. Sample: 192.168.10.1 \| \| excluded\_ipv6\_adresses complex \| changed \| Specifies IPV6 address spaces for which traffic is not forced through the tunnel. Sample: hash/dictionary of values \| \| \| subnet string \| changed \| The host or network address. Sample: 2001:DB8:ABCD:0012::0 \| \| ip\_version string \| changed \| Supported IP version on the network access resource. Sample: ipv4-ipv6 \| \| ipv4\_address\_space complex \| changed \| Specifies a list of IPv4 hosts or networks describing the target LAN. Sample: hash/dictionary of values \| \| \| subnet string \| changed \| The host or network address. Sample: 192.168.10.1 \| \| ipv4\_lease\_pool string \| changed \| Specifies a IPV4 lease pool resource to use with network access. Sample: /Common/leasepoolv4 \| \| ipv6\_address\_space complex \| changed \| Specifies a list of IPv6 hosts or networks describing the target LAN. Sample: hash/dictionary of values \| \| \| subnet string \| changed \| The host or network address. Sample: 2001:DB8:ABCD:0012::0 \| \| ipv6\_lease\_pool string \| changed \| Specifies a IPV6 lease pool resource to use with network access. Sample: /Common/leasepoolv6 \| \| snat\_pool string \| changed \| The name of a SNAT pool used by the network access resource. Sample: /Common/my-pool \| \| split\_tunnel boolean \| changed \| Enables split tunnel on the network access resource. Sample: True \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_gtm_server – Manages F5 BIG-IP GTM servers f5networks.f5\_modules.bigip\_gtm\_server – Manages F5 BIG-IP GTM servers ========================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_server`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP GTM (now BIG-IP DNS) server configuration. This module is able to manipulate the server definitions in a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| availability\_requirements dictionary \| \| If you activate more than one health monitor, specifies the number of health monitors that must receive successful responses in order for the link to be considered available. \| \| \| at\_least integer \| \| Specifies the minimum number of active health monitors that must be successful before the link is considered up. This parameter is only relevant when a `type` of `at_least` is used. This parameter will be ignored if a type of either `all` or `require` is used. \| \| \| number\_of\_probers integer \| \| Specifies the number of probers that should be used when running probes. When creating a new virtual server, if this parameter is specified, the `number_of_probes` parameter must also be specified. The value of this parameter should always be higher than, or equal to, the value of `number_of_probers`. This parameter is only relevant when a `type` of `require` is used. This parameter will be ignored if a type of either `all` or `at_least` is used. \| \| \| number\_of\_probes integer \| \| Specifies the minimum number of probes that must succeed for this server to be declared up. When creating a new virtual server, if this parameter is specified, then the `number_of_probers` parameter must also be specified. The value of this parameter should always be lower than, or equal to, the value of `number_of_probers`. This parameter is only relevant when a `type` of `require` is used. This parameter will be ignored if a type of either `all` or `at_least` is used. \| \| \| type string / required \| Choices:* all * at\_least * require \| Monitor rule type when `monitors` is specified. When creating a new pool, if this value is not specified, the default of all will be used. \| \| datacenter string \| \| Data center to which the server belongs. When creating a new GTM server, this value is required. \| \| devices raw \| \| Lists the self IP addresses and translations for each device. When creating a new GTM server, this value is required. This list is a complex list that specifies a number of keys. The `name` key specifies a name for the device. The device name must be unique per server. This key is required. The `address` key contains an IP address, or list of IP addresses, for the destination server. This key is required. The `translation` key contains an IP address to translate the `address` value above to. This key is optional. Specifying duplicate `name` fields is a supported means of providing device addresses. In this scenario, the addresses will be assigned to the `name`'s list of addresses. \| \| iquery\_options dictionary \| \| Specifies whether the Global Traffic Manager uses this BIG-IP system to conduct a variety of probes before delegating traffic to it. \| \| \| allow\_path boolean \| Choices:* no * yes \| Specifies the system verifies the logical network route between a data center server and a local DNS server. \| \| \| allow\_service\_check boolean \| Choices:* no * yes \| Specifies the system verifies that an application on a server is running, by remotely running the application using an external service checker program. \| \| \| allow\_snmp boolean \| Choices:* no * yes \| Specifies the system checks the performance of a server running an SNMP agent. \| \| limits dictionary \| \| Specifies resource thresholds or limit requirements at the pool member level. When you enable one or more limit settings, the system then uses that data to take members in and out of service. You can define limits for any or all of the limit settings. However, when a member does not meet the resource threshold limit requirement, the system marks the member as unavailable and directs load balancing traffic to another resource. \| \| \| bits\_enabled boolean \| Choices:* no * yes \| Whether the bits limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| bits\_limit integer \| \| Specifies the maximum allowable data throughput rate for the member, in bits per second. If the network traffic volume exceeds this limit, the system marks the member as unavailable. \| \| \| connections\_enabled boolean \| Choices:* no * yes \| Whether the current connections limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| connections\_limit integer \| \| Specifies the maximum number of concurrent connections, combined, for all of the members. If the connections exceed this limit, the system marks the server as unavailable. \| \| \| cpu\_enabled boolean \| Choices:* no * yes \| Whether the CPU limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| cpu\_limit integer \| \| Specifies the percent of CPU usage. If percent of CPU usage goes above the limit, the system marks the server as unavailable. \| \| \| memory\_enabled boolean \| Choices:* no * yes \| Whether the memory limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| memory\_limit integer \| \| Specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. \| \| \| packets\_enabled boolean \| Choices:* no * yes \| Whether the packets limit it enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| packets\_limit integer \| \| Specifies the maximum allowable data transfer rate for the member, in packets per second. If the network traffic volume exceeds this limit, the system marks the member as unavailable. \| \| link\_discovery string \| Choices:* enabled * disabled * enabled-no-delete \| Specifies whether the system auto-discovers the links for this server. When creating a new GTM server, if this parameter is not specified, the default value `disabled` is used. If you set this parameter to `enabled` or `enabled-no-delete`, you must also ensure the `virtual_server_discovery` parameter is also set to `enabled` or `enabled-no-delete`. \| \| monitors list / elements=string \| \| Specifies the health monitors the system currently uses to monitor this resource. When `availability_requirements.type` is `require`, you may only have a single monitor in the `monitors` list. \| \| name string / required \| \| The name of the server. If the virtual server is auto-discovered from the LTM,then the partition name needs to be included as part of the virtual server name when referencing from the module e.g. "/Common/vsname". \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| prober\_fallback string \| Choices:* any * inside-datacenter * outside-datacenter * inherit * pool * none \| Specifies the type of prober to use to monitor this server's resources when the preferred prober is not available. This option is ignored in `TMOS` version `12.x`. From `TMOS` version `13.x` and up, when prober\_preference is set to `pool` a `prober_pool` parameter must be specified. The choices are mutually exclusive with prober\_preference parameter, with the exception of the `any-available` or `none` options. \| \| prober\_pool string \| \| Specifies the name of the prober pool to use to monitor this server's resources. In `TMOS` version `13.x` and later, this parameter is mandatory when `prober_preference` is set to `pool`. The format of the name can be either be prepended by partition (`/Common/foo`), or specified just as an object name (`foo`). In `TMOS` version `12.x`, prober\_pool can be set to an empty string to revert to default setting of `inherit`. \| \| prober\_preference string \| Choices:* inside-datacenter * outside-datacenter * inherit * pool \| Specifies the type of prober to use to monitor this server's resources. This option is ignored in `TMOS` version `12.x`. From `TMOS` version `13.x` and up, when prober\_preference is set to `pool` a `prober_pool` parameter must be specified. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| server\_type string \| Choices:* alteon-ace-director * cisco-css * cisco-server-load-balancer * generic-host * radware-wsd * windows-nt-4.0 * bigip * cisco-local-director-v2 * extreme * generic-load-balancer * sun-solaris * cacheflow * cisco-local-director-v3 * foundry-server-iron * netapp * windows-2000-server \| Specifies the server type. The server type determines the metrics the system can collect from the server. When creating a new GTM server, the default value `bigip` is used. aliases: product \| \| state string \| Choices:* present ← * absent * enabled * disabled \| The server state. If `absent`, the module attempts to delete the server. This will only succeed if this server is not in use by a virtual server. `present` creates the server and enables it. If `enabled`, enables the server if it exists. If `disabled`, creates the server if needed, and sets state to `disabled`. \| \| virtual\_server\_discovery string \| Choices:* enabled * disabled * enabled-no-delete \| Specifies whether the system auto-discovers the virtual servers for this server. When creating a new GTM server, if this parameter is not specified, the default value `disabled` is used. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create server "GTM_Server" bigip_gtm_server: name: GTM_Server datacenter: /Common/New York server_type: bigip link_discovery: disabled virtual_server_discovery: disabled devices: - name: server_1 address: 1.1.1.1 - name: server_2 address: 2.2.2.1 translation: 192.168.2.1 - name: server_2 address: 2.2.2.2 - name: server_3 addresses: - address: 3.3.3.1 - address: 3.3.3.2 - name: server_4 addresses: - address: 4.4.4.1 translation: 192.168.14.1 - address: 4.4.4.2 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Create server "GTM_Server" with expanded keys bigip_gtm_server: server: lb.mydomain.com user: admin password: secret name: GTM_Server datacenter: /Common/New York server_type: bigip link_discovery: disabled virtual_server_discovery: disabled devices: - name: server_1 address: 1.1.1.1 - name: server_2 address: 2.2.2.1 translation: 192.168.2.1 - name: server_2 address: 2.2.2.2 - name: server_3 addresses: - address: 3.3.3.1 - address: 3.3.3.2 - name: server_4 addresses: - address: 4.4.4.1 translation: 192.168.14.1 - address: 4.4.4.2 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| bits\_enabled boolean \| changed \| Whether the bits limit is enabled. Sample: True \| \| bits\_limit integer \| changed \| The new bits\_enabled limit. Sample: 100 \| \| connections\_enabled boolean \| changed \| Whether the connections limit is enabled. Sample: True \| \| connections\_limit integer \| changed \| The new connections\_limit limit. Sample: 100 \| \| datacenter string \| changed \| The new `datacenter` which the server is a part of. Sample: datacenter01 \| \| link\_discovery string \| changed \| The new `link_discovery` configured on the remote device. Sample: enabled \| \| monitors list / elements=string \| changed \| The new list of monitors for the resource. Sample: ['/Common/monitor1', '/Common/monitor2'] \| \| packets\_enabled boolean \| changed \| Whether the packets limit is enabled. Sample: True \| \| packets\_limit integer \| changed \| The new packets\_limit limit. Sample: 100 \| \| server\_type string \| changed \| The new type of the server. Sample: bigip \| \| virtual\_server\_discovery string \| changed \| The new `virtual_server_discovery` name for the trap destination. Sample: disabled \| ### Authors * Robert Teller (@r-teller) * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_tcp_half_open – Manages F5 BIG-IP LTM TCP half-open monitors f5networks.f5\_modules.bigip\_monitor\_tcp\_half\_open – Manages F5 BIG-IP LTM TCP half-open monitors ===================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_tcp_half_open`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM TCP half-open monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value is 5. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If this value is an IP address, and the `type` is `tcp` (the default), then a `port` number must be specified. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/tcp\_half\_open" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `tcp_half_open` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must specify a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of `0` will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, the default value is be 0. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, then the default value is 16. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create TCP half-open Monitor bigip_monitor_tcp_half_open: state: present ip: 10.10.10.10 name: my_tcp_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove TCP half-open Monitor bigip_monitor_tcp_half_open: state: absent name: my_tcp_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add half-open monitor for all addresses, port 514 bigip_monitor_tcp_half_open: port: 514 name: my_tcp_monitor provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: tcp \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_sys_global – Manage BIG-IP global settings f5networks.f5\_modules.bigip\_sys\_global – Manage BIG-IP global settings ========================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_sys_global`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP global settings. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| banner\_text string \| \| Specifies the text to present in the advisory banner. \| \| console\_timeout integer \| \| Specifies the number of seconds of inactivity before the system logs off a user that is logged on. \| \| gui\_setup boolean \| Choices:* no * yes \| `yes` or `no`, the Setup utility in the browser-based Configuration utility. \| \| lcd\_display boolean \| Choices:* no * yes \| When `yes`, specifies the system menu displays on the LCD screen on the front of the unit. This setting has no effect when used on the VE platform. \| \| mgmt\_dhcp boolean \| Choices:* no * yes \| Specifies whether or not to enable DHCP client on the management interface. \| \| net\_reboot boolean \| Choices:* no * yes \| When `yes`, specifies the next time you reboot the system, the system boots to an ISO image on the network, rather than an internal media drive. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| quiet\_boot boolean \| Choices:* no * yes \| When `yes`, specifies the system suppresses informational text on the console during the boot cycle. When `no`, the system presents messages and informational text on the console during the boot cycle. \| \| security\_banner boolean \| Choices:* no * yes \| Specifies whether the system displays an advisory message on the login screen. \| \| state string \| Choices:* present ← \| The state of the variable on the system. When `present`, guarantees an existing variable is set to `value`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Disable the setup utility bigip_sys_global: gui_setup: no provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| banner\_text string \| changed \| The new text to present in the advisory banner. Sample: This is a corporate device. Do not touch. \| \| console\_timeout integer \| changed \| The new number of seconds of inactivity before the system logs off a user that is logged on. Sample: 600 \| \| gui\_setup boolean \| changed \| The new setting for the Setup utility. Sample: True \| \| lcd\_display boolean \| changed \| The new setting for displaying the system menu on the LCD. Sample: True \| \| mgmt\_dhcp boolean \| changed \| The new setting for whether the mgmt interface should use DHCP or not. Sample: True \| \| net\_reboot boolean \| changed \| The new setting for whether the system should boot to an ISO on the network or not. Sample: True \| \| quiet\_boot boolean \| changed \| The new setting for whether the system should suppress information to the console during boot or not. Sample: True \| \| security\_banner boolean \| changed \| The new setting for whether the system should display an advisory message on the login screen or not. Sample: True \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_ipsec_policy – Manage IPSec policies on a BIG-IP f5networks.f5\_modules.bigip\_ipsec\_policy – Manage IPSec policies on a BIG-IP =============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ipsec_policy`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage IPSec policies on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_algorithm string \| Choices:* sha1 * sha256 * sha384 * sha512 * aes-gcm128 * aes-gcm192 * aes-gcm256 * aes-gmac128 * aes-gmac192 * aes-gmac256 \| Specifies the algorithm to use for IKE authentication. \| \| description string \| \| Description of the policy \| \| encrypt\_algorithm string \| Choices:* none * 3des * aes128 * aes192 * aes256 * aes-gmac256 * aes-gmac192 * aes-gmac128 * aes-gcm256 * aes-gcm192 * aes-gcm256 * aes-gcm128 \| Specifies the algorithm to use for IKE encryption. \| \| ipcomp string \| Choices:* none * null * deflate \| Specifies whether to use IPComp encapsulation. When `none`, specifies IPComp is disabled. When `deflate`, specifies IPComp is enabled and uses the Deflate compression algorithm. \| \| ipv4\_interface boolean \| Choices:* no * yes \| When `mode` is `interface`, indicates if the IPv4 `any` address should be used. By default `BIG-IP` assumes `any6` address for tunnel addresses when `mode` is `interface`. This option takes effect only when `mode` is set to `interface`. \| \| kb\_lifetime integer \| \| Specifies the length of time before the IKE security association, in kilobytes. expires. \| \| lifetime integer \| \| Specifies the length of time before the IKE security association expires, in minutes. \| \| mode string \| Choices:* transport * interface * isession * tunnel \| Specifies the processing mode. When `transport`, specifies a mode that encapsulates only the payload (adding an ESP header, trailer, and authentication tag). When `tunnel`, specifies a mode that includes encapsulation of the header as well as the payload (adding a new IP header, in addition to adding an ESP header, trailer, and authentication tag). If you select this option, you must also provide IP addresses for the local and remote endpoints of the IPsec tunnel. When `isession`, specifies the use of iSession over an IPsec tunnel. To use this option, you must also configure the iSession endpoints with IPsec in the Acceleration section of the user interface. When `interface`, specifies the IPsec policy can be used in the tunnel profile for network interfaces. \| \| name string / required \| \| Specifies the name of the IPSec policy. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| perfect\_forward\_secrecy string \| Choices:* none * modp768 * modp1024 * modp1536 * modp2048 * modp3072 * modp4096 * modp6144 * modp8192 \| Specifies the Diffie-Hellman group to use for IKE Phase 2 negotiation. \| \| protocol string \| Choices:* esp * ah \| Specifies the IPsec protocol. Options include ESP (Encapsulating Security Protocol) or AH (Authentication Header). \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| route\_domain integer \| \| Specifies the route domain, when `interface` is selected for the `mode` setting. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| tunnel\_local\_address string \| \| Specifies the local endpoint IP address of the IPsec tunnel. This parameter is only valid when `mode` is `tunnel`. \| \| tunnel\_remote\_address string \| \| Specifies the remote endpoint IP address of the IPsec tunnel. This parameter is only valid when `mode` is `tunnel`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a IPSec policy bigip_ipsec_policy: name: policy1 mode: tunnel tunnel_local_address: 1.1.1.1 tunnel_remote_address: 2.2.2. auth_algorithm: sha1 encrypt_algorithm: 3des protocol: esp perfect_forward_secrecy: modp1024 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| auth\_algorithm string \| changed \| The new IKE Phase 2 Authentication Algorithm value. Sample: sha512 \| \| description string \| changed \| The new description value. Sample: My policy \| \| encrypt\_algorithm string \| changed \| The new IKE Phase 2 Encryption Algorithm value. Sample: aes256 \| \| ipcomp string \| changed \| The new IKE Phase 2 IPComp value. Sample: deflate \| \| kb\_lifetime integer \| changed \| The new IKE Phase 2 KB Lifetime value. \| \| lifetime integer \| changed \| The new IKE Phase 2 Lifetime value. Sample: 1440 \| \| mode string \| changed \| The new Mode value. Sample: tunnel \| \| perfect\_forward\_secrecy string \| changed \| The new IKE Phase 2 Perfect Forward Secrecy value. Sample: modp2048 \| \| protocol string \| changed \| The new IPsec Protocol value. Sample: ah \| \| route\_domain integer \| changed \| The new Route Domain value when in Tunnel mode. Sample: 2 \| \| tunnel\_local\_address string \| changed \| The new Tunnel Local Address value. Sample: 1.2.2.1 \| \| tunnel\_remote\_address string \| changed \| The new Tunnel Remote Address value. Sample: 2.1.1.2 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_external – Manages external LTM monitors on a BIG-IP f5networks.f5\_modules.bigip\_monitor\_external – Manages external LTM monitors on a BIG-IP =========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_external`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages external LTM monitors on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| arguments string \| \| Specifies any command-line arguments the script requires. \| \| description string \| \| The description of the monitor. \| \| external\_program string \| \| Specifies the name of the file for the monitor to use. In order to reference a file, you must first import it using options on the System > File Management > External Monitor Program File List > Import screen. The BIG-IP system automatically places the file in the proper location on the file system. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value will be 5. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. \| \| name* string / required \| \| Specifies the name of the monitor. \| \| parent string \| Default:"/Common/external" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `external` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '\'. If specifying an IP address, you must use a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value will be `16`. \| \| variables dictionary \| \| Specifies any variables the script requires. Note that double quotes in values will be suppressed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an external monitor bigip_monitor_external: name: foo state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Create an external monitor with variables bigip_monitor_external: name: foo timeout: 10 variables: var1: foo var2: bar state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add a variable to an existing set bigip_monitor_external: name: foo timeout: 10 variables: var1: foo var2: bar cat: dog state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: external \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_static_route – Manipulate static routes on a BIG-IP f5networks.f5\_modules.bigip\_static\_route – Manipulate static routes on a BIG-IP ================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_static_route`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manipulate static routes on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Descriptive text that identifies the route. \| \| destination string \| \| Specifies an IP address for the static entry in the routing table. When creating a new static route, this value is required. This value cannot be changed once it is set. \| \| gateway\_address string \| \| Specifies the router for the system to use when forwarding packets to the destination host or network. Also known as the next-hop router address. This can be either an IPv4 or IPv6 address. When it is an IPv6 address that starts with `FE80:`, the address is treated as a link-local address. This requires the `vlan` parameter also be supplied. \| \| mtu string \| \| Specifies a specific maximum transmission unit (MTU). \| \| name string / required \| \| Name of the static route. \| \| netmask string \| \| The netmask for the static route. When creating a new static route, this value is required. This value can be in either IP or CIDR format. This value cannot be changed once it is set. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| pool string \| \| Specifies the pool through which the system forwards packets to the destination. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| reject boolean \| Choices:* no * yes \| Specifies the system drops packets sent to the destination. \| \| route\_domain integer \| \| The route domain ID of the system. When creating a new static route, if this value is not specified, the default value is `0`. This value cannot be changed once it is set. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the static route exists. When `absent`, ensures the static does not exist. \| \| vlan string \| \| Specifies the VLAN or Tunnel through which the system forwards packets to the destination. When `gateway_address` is a link-local IPv6 address, this value is required. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create static route with gateway address bigip_static_route: destination: 10.10.10.10 netmask: 255.255.255.255 gateway_address: 10.2.2.3 name: test-route provider: password: secret server: lb.mydomain.come user: admin validate_certs: no delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| Descriptive text that identifies the route. Sample: Route tho DMZ \| \| destination string \| changed \| An IP address for the static entry in the routing table. Sample: 0.0.0.0/0 \| \| gateway\_address string \| changed \| The router for the system to use when forwarding packets to the destination host or network. Sample: 10.2.2.3 \| \| netmask string \| changed \| Netmask of the destination. Sample: 255.255.255.255 \| \| partition string \| changed \| The partition that the static route was created on. Sample: Common \| \| pool string \| changed \| Whether the banner is enabled or not. Sample: True \| \| reject boolean \| changed \| Specifies the system drops packets sent to the destination. Sample: True \| \| route\_domain integer \| changed \| The route domain ID of the system. Sample: 1 \| \| vlan string \| changed \| The VLAN or Tunnel through which the system forwards packets to the destination. Sample: /Common/vlan1 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_firewall_rule – Manage AFM Firewall rules f5networks.f5\_modules.bigip\_firewall\_rule – Manage AFM Firewall rules ======================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_rule`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages firewall rules in an AFM (Advanced Firewall Manager) firewall policy. New rules will always be added to the end of the policy. Rules can be re-ordered using the `bigip_security_policy` module. Rules can also be pre-ordered using the `bigip_security_policy` module and then later updated using the `bigip_firewall_rule` module. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| action string \| Choices:* accept * drop * reject * accept-decisively \| Specifies the action for the firewall rule. When `accept`, allows packets with the specified source, destination, and protocol to pass through the firewall. Packets that match the rule and are accepted, traverse the system as if the firewall is not present. When `drop`, drops packets with the specified source, destination, and protocol. Dropping a packet is a silent action with no notification to the source or destination systems. Dropping the packet causes the connection to be retried until the retry threshold is reached. When `reject`, rejects packets with the specified source, destination, and protocol. When a packet is rejected, the firewall sends a destination unreachable message to the sender. When `accept-decisively`, allows packets with the specified source, destination, and protocol to pass through the firewall, and does not require any further processing by any of the further firewalls. Packets that match the rule and are accepted, traverse the system as if the firewall is not present. If the Rule List is applied to a virtual server, management IP, or self IP firewall rule, then Accept Decisively is equivalent to Accept. When creating a new rule, if this parameter is not provided, the default is `reject`. \| \| description string \| \| The rule description. \| \| destination list / elements=dictionary \| \| Specifies packet destinations to which the rule applies. Leaving this field blank applies the rule to all addresses and all ports. You can specify the following destination items. An IPv4 or IPv6 address, an IPv4 or IPv6 address range, geographic location, VLAN, address list, port, port range, port list or address list. You can specify a mix of different types of items for the source address. \| \| \| address string \| \| Specifies a specific IP address. \| \| \| address\_list string \| \| Specifies an existing address list. \| \| \| address\_range string \| \| Specifies an address range. \| \| \| country string \| \| Specifies a country code. \| \| \| port integer \| \| Specifies a single numeric port. This option is only valid when `protocol` is `tcp`(6) or `udp`(17). \| \| \| port\_list string \| \| Specifes an existing port list. This option is only valid when `protocol` is `tcp`(6) or `udp`(17). \| \| \| port\_range string \| \| Specifies a range of ports, which is two port values separated by a hyphen. The port to the left of the hyphen should be less than the port to the right. This option is only valid when `protocol` is `tcp`(6) or `udp`(17). \| \| icmp\_message list / elements=dictionary \| \| Specifies the Internet Control Message Protocol (ICMP) or ICMPv6 message `type` and `code` the rule uses. This parameter is only relevant when `protocol` is either `icmp`(1) or `icmpv6`(58). \| \| \| code string \| \| Specifies the code returned in response to the specified ICMP message type. You can specify codes, each set appropriate to the associated type, such as No Code (0) (associated with Echo Reply (0)) and Host Unreachable (1) (associated with Destination Unreachable (3)), or you can specify `any` to indicate the system applies the rule for all codes in response to that specific ICMP message. You can also specify an arbitrary code. The ICMP protocol contains definitions for the existing message code and number pairs. \| \| \| type string \| \| Specifies the type of ICMP message. You can specify control messages, such as Echo Reply (0) and Destination Unreachable (3), or you can specify `any` to indicate the system applies the rule for all ICMP messages. You can also specify an arbitrary ICMP message. The ICMP protocol contains definitions for the existing message type and number pairs. \| \| irule string \| \| Specifies an iRule that is applied to the firewall rule. An iRule can be started when the firewall rule matches traffic. \| \| logging boolean \| Choices:* no * yes \| Specifies whether logging is enabled or disabled for the firewall rule. When creating a new rule, if this parameter is not specified, the default if `no`. \| \| name string / required \| \| Specifies the name of the rule. \| \| parent\_policy string \| \| The policy which contains the rule to be managed. One of either `parent_policy` or `parent_rule_list` is required. \| \| parent\_rule\_list string \| \| The rule list which contains the rule to be managed. One of either `parent_policy` or `parent_rule_list` is required. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| protocol string \| \| Specifies the protocol to which the rule applies. Protocols may be specified by either their name or numeric value. A special protocol value `any` can be specified to match any protocol. The numeric equivalent of this protocol is `255`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rule\_list string \| \| Specifies an existing rule list to use in the rule. This parameter is mutually exclusive with many of the other individual-rule specific settings. This includes `logging`, `action`, `source`, `destination`, `irule'`, `protocol` and `logging`. This parameter is only used when `parent_policy` is specified, otherwise it is ignored. \| \| schedule string \| \| Specifies a schedule for the firewall rule. You configure schedules to define days and times when the firewall rule is made active. \| \| source list / elements=dictionary \| \| Specifies packet sources to which the rule applies. Leaving this field blank applies the rule to all addresses and all ports. You can specify the following source items. An IPv4 or IPv6 address, an IPv4 or IPv6 address range, geographic location, VLAN, address list, port, port range, port list or address list. You can specify a mix of different types of items for the source address. \| \| \| address string \| \| Specifies a specific IP address. \| \| \| address\_list string \| \| Specifies an existing address list. \| \| \| address\_range string \| \| Specifies an address range. \| \| \| country string \| \| Specifies a country code. \| \| \| port integer \| \| Specifies a single numeric port. This option is only valid when `protocol` is `tcp`(6) or `udp`(17). \| \| \| port\_list string \| \| Specifes an existing port list. This option is only valid when `protocol` is `tcp`(6) or `udp`(17). \| \| \| port\_range string \| \| Specifies a range of ports, which is two port values separated by a hyphen. The port to the left of the hyphen should be less than the port to the right. This option is only valid when `protocol` is `tcp`(6) or `udp`(17). \| \| \| vlan string \| \| Specifies VLANs to which the rule applies. The VLAN source refers to the packet's source. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the rule exists. When `state` is `absent`, ensures the rule is removed. \| \| status string \| Choices:* enabled * disabled * scheduled \| Indicates the activity state of the rule or rule list. When `disabled`, specifies the rule or rule list does not apply at all. When `enabled`, specifies the system applies the firewall rule or rule list to the given context and addresses. When `scheduled`, specifies the system applies the rule or rule list according to the specified schedule. When creating a new rule, if this parameter is not provided, the default is `enabled`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a new rule in the foo firewall policy bigip_firewall_rule: name: foo parent_policy: policy1 protocol: tcp source: - address: 1.2.3.4 - address: "::1" - address_list: foo-list1 - address_range: 1.1.1.1-2.2.2.2 - vlan: vlan1 - country: US - port: 22 - port_list: port-list1 - port_range: 80-443 destination: - address: 1.2.3.4 - address: "::1" - address_list: foo-list1 - address_range: 1.1.1.1-2.2.2.2 - country: US - port: 22 - port_list: port-list1 - port_range: 80-443 irule: irule1 action: accept logging: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create an ICMP specific rule bigip_firewall_rule: name: foo protocol: icmp icmp_message: type: 0 source: - country: US action: drop logging: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Add a new policy rule that uses an existing rule list bigip_firewall_rule: name: foo parent_policy: foo_policy rule_list: rule-list1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| action string \| changed \| The action for the firewall rule. Sample: drop \| \| description string \| changed \| The rule description. Sample: MyRule \| \| destination complex \| changed \| The packet destinations to which the rule applies. Sample: hash/dictionary of values \| \| \| address string \| changed \| A specific IP address. Sample: 192.168.1.1 \| \| \| address\_list string \| changed \| An existing address list. Sample: foo-list1 \| \| \| address\_range string \| changed \| The address range. Sample: 1.1.1.1-2.2.2.2 \| \| \| country string \| changed \| A country code. Sample: US \| \| \| port integer \| changed \| Single numeric port. Sample: 8080 \| \| \| port\_list string \| changed \| An existing port list. Sample: port-list1 \| \| \| port\_range string \| changed \| The port range. Sample: 80-443 \| \| icmp\_message complex \| changed \| The (ICMP) or ICMPv6 message `type` and `code` that the rule uses. Sample: hash/dictionary of values \| \| \| code string \| changed \| The code returned in response to the specified ICMP message type. Sample: 1 \| \| \| type string \| changed \| The type of ICMP message. \| \| irule string \| changed \| The iRule that is applied to the firewall rule. Sample: \_sys\_auth\_radius \| \| logging boolean \| changed \| Enable or Disable logging for the firewall rule. Sample: True \| \| name string \| changed \| Name of the rule. Sample: FooRule \| \| parent\_policy string \| changed \| The policy which contains the rule to be managed. Sample: FooPolicy \| \| parent\_rule\_list string \| changed \| The rule list which contains the rule to be managed. Sample: FooRuleList \| \| protocol string \| changed \| The protocol to which the rule applies. Sample: any \| \| rule\_list string \| changed \| An existing rule list to use in the parent policy. Sample: rule-list-1 \| \| schedule string \| changed \| The schedule for the firewall rule. Sample: Foo\_schedule \| \| source complex \| changed \| The packet sources to which the rule applies. Sample: hash/dictionary of values \| \| \| address string \| changed \| A specific IP address. Sample: 192.168.1.1 \| \| \| address\_list string \| changed \| An existing address list. Sample: foo-list1 \| \| \| address\_range string \| changed \| The address range. Sample: 1.1.1.1-2.2.2.2 \| \| \| country string \| changed \| A country code. Sample: US \| \| \| port integer \| changed \| Single numeric port. Sample: 8080 \| \| \| port\_list string \| changed \| An existing port list. Sample: port-list1 \| \| \| port\_range string \| changed \| The port range. Sample: 80-443 \| \| \| vlan string \| changed \| Source VLANs for the packets. Sample: vlan1 \| \| status string \| changed \| The activity state of the rule or rule list. Sample: scheduled \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_profile_http_compression – Manage HTTP compression profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_http\_compression – Manage HTTP compression profiles on a BIG-IP ======================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_http_compression`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage HTTP compression profiles on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| buffer\_size integer \| \| Maximum number of compressed bytes the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| description string \| \| Description of the HTTP compression profile. \| \| gzip\_level integer \| Choices:* 1 * 2 * 3 * 4 * 5 * 6 * 7 * 8 * 9 \| Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. Valid values are between 1 (least compression and fastest) to 9 (most compression and slowest). \| \| gzip\_memory\_level integer \| Choices:* 1 * 2 * 4 * 8 * 16 * 32 * 64 * 128 * 256 \| Number of kilobytes of memory the system uses for internal compression buffers when compressing a server response. \| \| gzip\_window\_size integer \| Choices:* 1 * 2 * 4 * 8 * 16 * 32 * 64 * 128 \| Number of kilobytes in the window size the system uses when compressing a server response. \| \| name string / required \| \| Specifies the name of the compression profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `httpcompression` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an HTTP compression profile bigip_profile_http_compression: name: profile1 description: Custom HTTP Compression Profile buffer_size: 131072 gzip_level: 6 gzip_memory_level: 16k gzip_window_size: 64k provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| buffer\_size integer \| changed \| The new buffer size of the profile. Sample: 4096 \| \| description string \| changed \| The new description of the resource. Sample: My custom profile \| \| gzip\_level integer \| changed \| The new GZIP level of the profile. Smaller is less compression. Sample: 2 \| \| gzip\_memory\_level integer \| changed \| The new GZIP memory level of the profile, in KB. Sample: 16 \| \| gzip\_window\_size integer \| changed \| The new GZIP window size of the profile, in KB. Sample: 64 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_gtm_datacenter – Manage Datacenter configuration in BIG-IP f5networks.f5\_modules.bigip\_gtm\_datacenter – Manage Datacenter configuration in BIG-IP ========================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_datacenter`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP data center configuration. A data center defines the location where the physical network components reside, such as the server and link objects that share the same subnet on the network. This module is able to manipulate the data center definitions in a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| contact string \| \| The name of the contact for the data center. \| \| description string \| \| The description of the data center. \| \| location string \| \| The location of the data center. \| \| name string / required \| \| The name of the data center. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent * enabled * disabled \| The virtual address state. If `absent`, an attempt to delete the virtual address will be made. This will only succeed if this virtual address is not in use by a virtual server. `present` creates the virtual address and enables it. If `enabled`, enables the virtual address if it exists. If `disabled`, creates the virtual address if needed, and sets state to `disabled`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create data center "New York" bigip_gtm_datacenter: name: New York location: 222 West 23rd provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| contact string \| changed \| The contact that was set on the datacenter. Sample: [email protected] \| \| description string \| changed \| The description for the datacenter. Sample: Datacenter in NYC \| \| disabled boolean \| changed \| Whether the datacenter is disabled or not. Sample: True \| \| enabled boolean \| changed \| Whether the datacenter is enabled or not. Sample: True \| \| location string \| changed \| The location for the datacenter. Sample: 222 West 23rd \| \| state string \| changed \| State of the datacenter. Sample: disabled \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_profile_sip – Manage SIP profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_sip – Manage SIP profiles on a BIG-IP ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_sip`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage SIP profiles on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| community string \| \| When the `dialog_aware` is `yes` and the configuration requires multiple SIP virtual server-profile pairings, this string value indicates whether the pair belongs to the same SIP proxy functional group. \| \| description string \| \| Description of the profile. To remove the entry completely, set a value of `''`. \| \| dialog\_aware boolean \| Choices:* no * yes \| When `yes`, the system gathers SIP dialog information and automatically forwards SIP messages belonging to the known SIP dialog. \| \| enable\_sip\_firewall boolean \| Choices:* no * yes \| Specifies whether the Advanced Firewall Manager (AFM) policy is enabled. When `yes`, the SIP Security settings configured in the DoS Profile in AFM apply to the virtual servers that use this profile. \| \| insert\_record\_route\_header boolean \| Choices:* no * yes \| When `yes`, inserts a Record-Route SIP header, which indicates the next hop for the following SIP request messages. \| \| insert\_via\_header boolean \| Choices:* no * yes \| When `yes`, inserts a Via header in the forwarded SIP request. Via headers indicate the path taken through proxy devices and transports used. The response message uses this routing information. \| \| log\_profile string \| \| Specifies the logging settings the publisher uses to send log messages. The format of the name can be either be prepended by partition (`/Common/foo`), or specified just as an object name (`foo`). To remove the entry. set a value of `''`, however the profile `log_publisher` must also be set as `''`. \| \| log\_publisher string \| \| Specifies the publisher defined to log messages. Format of the name can be either be prepended by partition (`/Common/foo`), or specified just as an object name (`foo`). To remove the entry. set a value of `''`, however the profile `log_profile` must also be set as `''`. \| \| max\_size integer \| \| Specifies the maximum SIP message size that the BIG-IP system accepts. The accepted value range is `0 - 4294967295` bytes. \| \| name string / required \| \| Specifies the name of the SIP profile to manage. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `sip` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| secure\_via\_header boolean \| Choices:* no * yes \| When checked (enabled), inserts a secure Via header in the forwarded SIP request. A secure Via header indicates where the message originated. This parameter causes the inserted Via header to specify Transport Layer Security. For this option to take effect, `insert_via_header` must be set to (yes). \| \| security boolean \| Choices:* no * yes \| When `yes`. enables the use of enhanced Horizontal Security Layer (HSL) security checking. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| terminate\_on\_bye boolean \| Choices:* no * yes \| When `yes`, closes a connection when a BYE transaction finishes. A BYE transaction is a message an application sends to another application when it is ready to close the connection between the two. \| \| user\_via\_header string \| \| When `insert_via_header` is `yes`, specifies the Via value the system inserts as the top Via header in a SIP REQUEST message. The valid value must include SIP protocol and sent\_by settings, for example: `SIP/2.0/UDP 10.10.10.10:5060`. To remove the entry completely, set a value of `''`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a SIP profile bigip_profile_sip: name: foo parent: sip log_profile: alg_log log_publisher: foo-publisher description: this is a new profile security: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update SIP profile bigip_profile_sip: name: foo insert_record_route_header: yes enable_sip_firewall: yes insert_via_header: yes user_via_header: "SIP/2.0/UDP 10.10.10.10:5060" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Delete a SIP profile bigip_profile_sip: name: foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| community string \| changed \| Indicates whether the pair belongs to the same SIP proxy functional group. Sample: foo\_community \| \| description string \| changed \| Description of the profile. Sample: custom description \| \| dialog\_aware boolean \| changed \| Specifies if the system gathers SIP dialog information. \| \| enable\_sip\_firewall boolean \| changed \| Specifies whether the Advanced Firewall Manager policy is enabled. Sample: True \| \| insert\_record\_route\_header boolean \| changed \| Specifies if the system will insert a Record-Route SIP header. Sample: True \| \| insert\_via\_header boolean \| changed \| Specifies if the system will insert a Via header in the forwarded SIP request. Sample: True \| \| log\_profile string \| changed \| The logging settings the publisher uses to send log messages. Sample: /Common/alg\_profile \| \| log\_publisher string \| changed \| The publisher defined to log messages. Sample: /Common/foo\_publisher \| \| max\_size boolean \| changed \| Specifies if the system will close a connection when a BYE transaction finishes. \| \| parent string \| changed \| Specifies the profile from which this profile inherits settings. Sample: /Common/sip \| \| secure\_via\_header boolean \| changed \| Specifies if the system will insert a secure Via header in the forwarded SIP request. \| \| security boolean \| changed \| Enables the use of enhanced Horizontal Security Layer security checking. Sample: True \| \| terminate\_on\_bye boolean \| changed \| Specifies if the system will close a connection when a BYE transaction finishes. \| \| user\_via\_header string \| changed \| The value the system inserts as the top Via header in a SIP REQUEST message. Sample: SIP/2.0/UDP 10.10.10.10:5060 \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigiq_application_fasthttp – Manages BIG-IQ FastHTTP applications f5networks.f5\_modules.bigiq\_application\_fasthttp – Manages BIG-IQ FastHTTP applications ========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_application_fasthttp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IQ applications used for load balancing an HTTP-based application, speeding up connections and reducing the number of connections to the back-end server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| add\_analytics boolean \| Choices:* no ← * yes \| Collects statistics of the BIG-IP to which the application is deployed. This parameter is only relevant when specifying a `service_environment` which is a BIG-IP; not an SSG. \| \| description string \| \| Description of the application. \| \| inbound\_virtual dictionary \| \| Settings to configure the virtual which receives the inbound connection. This virtual is used to host the HTTP endpoint of the application. \| \| \| address string / required \| \| Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. \| \| \| netmask string / required \| \| Specifies the netmask to associate with the given `destination`. This parameter is required when creating a new application. \| \| \| port string \| Default:80 \| The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is `80`. \| \| name string / required \| \| Name of the new application. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| servers list / elements=dictionary \| \| A list of servers on which the application is hosted. If you are familiar with other BIG-IP settings, you might also refer to this list as the list of pool members. When creating a new application, at least one server is required. \| \| \| address string / required \| \| The IP address of the server. \| \| \| port string \| Default:80 \| The port of the server. When creating a new application and specifying a server, if this parameter is not provided, the default is `80`. \| \| service\_environment string \| \| Specifies the name of the service environment to which the application is. When creating a new application, this parameter is required. The service environment type is automatically discovered by this module. Therefore, it is crucial you maintain unique names for items in the different service environment types (at this time, SSGs and BIGIPs). \| \| state string \| Choices:* absent * present ← \| The state of the resource on the system. When `present`, guarantees the resource exists with the provided attributes. When `absent`, removes the resource from the system. \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the application to be created, deleted, or updated. \| Notes ----- Note * This module does not support updating of your application (whether deployed or not). If you need to update the application, we recommended removing and re-creating it. * This module does not work on BIG-IQ version 6.1.x or greater. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Load balance an HTTP application on port 80 on BIG-IP bigiq_application_fasthttp: name: my-app description: Fast HTTP service_environment: my-ssg servers: - address: 1.2.3.4 port: 8080 - address: 5.6.7.8 port: 8080 inbound_virtual: name: foo address: 2.2.2.2 netmask: 255.255.255.255 port: 80 provider: password: secret server: lb.mydomain.com user: admin state: present delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the application of the resource. Sample: My application \| \| inbound\_virtual\_destination string \| changed \| The destination of the virtual that was created. Sample: 6.7.8.9 \| \| inbound\_virtual\_netmask string \| changed \| The network mask of the provided inbound destination. Sample: 255.255.255.0 \| \| inbound\_virtual\_port integer \| changed \| The port on which the inbound virtual address listens. Sample: 80 \| \| servers complex \| changed \| List of servers and their ports that make up the application. Sample: hash/dictionary of values \| \| \| address string \| changed \| The IP address of the server. Sample: 2.3.4.5 \| \| \| port integer \| changed \| The port the server listens on. Sample: 8080 \| \| service\_environment string \| changed \| The environment to which the service was deployed. Sample: my-ssg1 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_node – Manages F5 BIG-IP LTM nodes f5networks.f5\_modules.bigip\_node – Manages F5 BIG-IP LTM nodes ================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_node`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM nodes. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| IP address of the node. This can be either IPv4 or IPv6. When creating a new node, you must provide one of either `address` or `fqdn`. This parameter cannot be updated after it is set. aliases: ip, host \| \| availability\_requirements dictionary \| \| If you activate more than one health monitor, specifies the number of health monitors that must receive successful responses in order for the link to be considered available. \| \| \| at\_least integer \| \| Specifies the minimum number of active health monitors that must be successful before the link is considered up. This parameter is only relevant when a `type` of `at_least` is used. This parameter will be ignored if a type of `all` is used. \| \| \| type string / required \| Choices:* all * at\_least \| Monitor rule type when `monitors` is specified. When creating a new pool, if this value is not specified, the default of 'all' will be used. \| \| connection\_limit integer \| \| Node connection limit. Setting this to `0` disables the limit. \| \| description string \| \| Specifies descriptive text that identifies the node. You can remove a description by either specifying an empty string, or by specifying the special value `none`. \| \| dynamic\_ratio integer \| \| The dynamic ratio number for the node. Used for dynamic ratio load balancing. When creating a new node, if this parameter is not specified, the default of `1` will be used. \| \| fqdn string \| \| FQDN name of the node. This can be any name that is a valid RFC 1123 DNS name. Therefore, the only characters that can be used are "A" to "Z", "a" to "z", "0" to "9", the hyphen ("-") and the period ("."). FQDN names must include at least one period; delineating the host from the domain. For example, `host.domain`. FQDN names must end with a letter or a number. When creating a new node, you must provide one of either `address` or `fqdn` provided. This parameter cannot be updated after it is set. aliases: hostname \| \| fqdn\_address\_type string \| Choices:* ipv4 * ipv6 * all \| Specifies whether the FQDN of the node resolves to an IPv4 or IPv6 address. When creating a new node, if this parameter is not specified and `fqdn` is specified, this parameter will default to `ipv4`. This parameter cannot be changed after it has been set. \| \| fqdn\_auto\_populate boolean \| Choices:* no * yes \| Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. When `yes`, the system generates an ephemeral node for each IP address returned in response to a DNS query for the FQDN of the node. Additionally, when a DNS response indicates the IP address of an ephemeral node no longer exists, the system deletes the ephemeral node. When `no`, the system resolves a DNS query for the FQDN of the node with the single IP address associated with the FQDN. When creating a new node, if this parameter is not specified and `fqdn` is specified, this parameter will default to `yes`. This parameter cannot be changed after it has been set. \| \| fqdn\_down\_interval integer \| \| Specifies the interval in which a query occurs, when the DNS server is down. The associated monitor continues polling as long as the DNS server is down. When creating a new node, if this parameter is not specified and `fqdn` is specified, this parameter will default to `5`. \| \| fqdn\_up\_interval string \| \| Specifies the interval at which a query occurs, when the DNS server is up. The associated monitor attempts to probe three times, and marks the server down if it there is no response within the span of three times the interval value, in seconds. This parameter accepts a value of `ttl` to query, based off of the TTL of the FQDN. The default TTL interval is similar to specifying `3600`. When creating a new node, if this parameter is not specified and `fqdn` is specified, this parameter will default to `3600`. \| \| monitors list / elements=string \| \| Specifies the health monitors the system currently uses to monitor this node. \| \| name string / required \| \| Specifies the name of the node. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rate\_limit integer \| \| Node rate limit (connections-per-second). Setting this to `0` disables the limit. \| \| ratio integer \| \| Node ratio weight. Valid values range from 1 through 100. When creating a new node, if this parameter is not specified, the default of `1` will be used. \| \| state string \| Choices:* present ← * absent * enabled * disabled * offline \| Specifies the current state of the node. `enabled` (All traffic allowed), specifies the system sends traffic to this node regardless of the node's state. `disabled` (Only persistent or active connections allowed), specifies the node can handle only persistent or active connections. `offline` (Only active connections allowed), specifies the node can handle only active connections. In all cases except `absent`, the node will be created if it does not yet exist. Be particularly careful about changing the status of a node whose FQDN cannot be resolved. These situations disable your ability to change their `state` to `disabled` or `offline`. They will remain in an \Unavailable - Enabled\ state. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add node bigip_node: host: 10.20.30.40 name: 10.20.30.40 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add node with a single 'ping' monitor bigip_node: host: 10.20.30.40 name: mytestserver monitors: - /Common/icmp provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Modify node description bigip_node: name: 10.20.30.40 description: Our best server yet provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Delete node bigip_node: state: absent name: 10.20.30.40 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Force node offline bigip_node: state: disabled name: 10.20.30.40 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add node by their FQDN bigip_node: fqdn: foo.bar.com name: foobar.net provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed and success \| Changed value for the description of the node. Sample: E-Commerce webserver in ORD \| \| monitors list / elements=string \| changed and success \| Changed list of monitors for the node. Sample: ['icmp', 'tcp\_echo'] \| \| session string \| changed and success \| Changed value for the internal session of the node. Sample: user-disabled \| \| state string \| changed and success \| Changed value for the internal state of the node. Sample: user-down \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_gtm_virtual_server – Manages F5 BIG-IP GTM virtual servers f5networks.f5\_modules.bigip\_gtm\_virtual\_server – Manages F5 BIG-IP GTM virtual servers ========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_virtual_server`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP GTM (now BIG-IP DNS) virtual servers. A GTM server can have many virtual servers associated with it. They are arranged in much the same way that pool members are to pools. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| Specifies the IP Address of the virtual server. When creating a new GTM virtual server, this parameter is required. \| \| availability\_requirements dictionary \| \| If you activate more than one health monitor, specifies the number of health monitors that must receive successful responses in order for the link to be considered available. \| \| \| at\_least integer \| \| Specifies the minimum number of active health monitors that must be successful before the link is considered up. This parameter is only relevant when a `type` of `at_least` is used. This parameter will be ignored if a type of either `all` or `require` is used. \| \| \| number\_of\_probers integer \| \| Specifies the number of probers that should be used when running probes. When creating a new virtual server, if this parameter is specified, the `number_of_probes` parameter must also be specified. The value of this parameter should always be higher than or equal to the value of `number_of_probers`. This parameter is only relevant when a `type` of `require` is used. This parameter will be ignored if a type of either `all` or `at_least` is used. \| \| \| number\_of\_probes integer \| \| Specifies the minimum number of probes that must succeed for this server to be declared up. When creating a new virtual server, if this parameter is specified, then the `number_of_probers` parameter must also be specified. The value of this parameter should always be lower than or equal to the value of `number_of_probers`. This parameter is only relevant when a `type` of `require` is used. This parameter will be ignored if a type of either `all` or `at_least` is used. \| \| \| type string / required \| Choices:* all * at\_least * require \| Monitor rule type when `monitors` is specified. When creating a new virtual, if this value is not specified, the default of `all` will be used. \| \| limits dictionary \| \| Specifies resource thresholds or limit requirements at the server level. When you enable one or more limit settings, the system then uses that data to take servers in and out of service. You can define limits for any or all of the limit settings. However, when a server does not meet the resource threshold limit requirement, the system marks the entire server as unavailable and directs load balancing traffic to another resource. The limit settings available depend on the type of server. \| \| \| bits\_enabled boolean \| Choices:* no * yes \| Whether the bits limit is enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| bits\_limit integer \| \| Specifies the maximum allowable data throughput rate for the virtual servers on the server, in bits per second. If the network traffic volume exceeds this limit, the system marks the server as unavailable. \| \| \| connections\_enabled boolean \| Choices:* no * yes \| Whether the current connections limit is enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| connections\_limit integer \| \| Specifies the maximum number of concurrent connections, combined, for all of the virtual servers on the server. If the connections exceed this limit, the system marks the server as unavailable. \| \| \| packets\_enabled boolean \| Choices:* no * yes \| Whether the packets limit is enabled or not. This parameter allows you to switch on or off the effect of the limit. \| \| \| packets\_limit integer \| \| Specifies the maximum allowable data transfer rate for the virtual servers on the server, in packets per second. If the network traffic volume exceeds this limit, the system marks the server as unavailable. \| \| link string \| \| Specifies a link to assign to the server or virtual server. \| \| monitors list / elements=string \| \| Specifies the health monitors the system currently uses to monitor this resource. When `availability_requirements.type` is `require`, you may only have a single monitor in the `monitors` list. \| \| name string / required \| \| Specifies the name of the virtual server. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port integer \| \| Specifies the service port number for the virtual server or pool member. For example, the HTTP service is typically port 80. To specify all ports, use an ``. When creating a new GTM virtual server, if this parameter is not specified, a default of `` will be used. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| server\_name string / required \| \| Specifies the name of the server the virtual server is associated with. \| \| state string \| Choices:* present ← * absent * enabled * disabled \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| translation\_address string \| \| Specifies the translation IP address for the virtual server. To unset this parameter, use an empty string (`""`) as a value. When creating a new GTM virtual server, if this parameter is not specified, a default of `::` will be used. \| \| translation\_port string \| \| Specifies the translation port number or service name for the virtual server. To specify all ports, use an ``. When creating a new GTM virtual server, if this parameter is not specified, a default of `` will be used. \| \| virtual\_server\_dependencies list / elements=dictionary \| \| Specifies the virtual servers on which the current virtual server depends. If any of the specified servers are unavailable, the current virtual server is also listed as unavailable. \| \| \| server string / required \| \| Server which the dependant virtual server is part of. \| \| \| virtual\_server string / required \| \| Virtual server to depend on. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Enable virtual server bigip_gtm_virtual_server: server_name: server1 name: my-virtual-server state: enabled provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address string \| changed \| The new address of the resource. Sample: 1.2.3.4 \| \| availability\_requirements dictionary \| changed \| The new availability requirement configurations for the resource. Sample: {'type': 'all'} \| \| limits dictionary \| changed \| The new limit configurations for the resource. Sample: {'bits\_enabled': True, 'bits\_limit': 100} \| \| link string \| changed \| The new link value for the resource. Sample: /Common/my-link \| \| monitors list / elements=string \| changed \| The new list of monitors for the resource. Sample: ['/Common/monitor1', '/Common/monitor2'] \| \| port integer \| changed \| The new port of the resource. Sample: 500 \| \| server\_name string \| changed \| The server name associated with the virtual server. Sample: /Common/my-gtm-server \| \| translation\_address integer \| changed \| The new translation address of the resource. Sample: 500 \| \| translation\_port integer \| changed \| The new translation port of the resource. Sample: 500 \| \| virtual\_server\_dependencies list / elements=string \| changed \| The new list of virtual server dependencies for the resource. Sample: ['/Common/vs1', '/Common/vs2'] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_remote_role – Manage remote roles on a BIG-IP f5networks.f5\_modules.bigip\_remote\_role – Manage remote roles on a BIG-IP ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_remote_role`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages remote roles on a BIG-IP system. Remote roles are used in situations where user authentication is handled off-box. Local access control to the BIG-IP is controlled by the defined remote role, and authentication (and by extension, assignment to the role) is handled off-box. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| assigned\_role string \| \| Specifies the authorization (level of access) for the account. When creating a new remote role, if this parameter is not provided, the default is `none`. The `partition_access` parameter controls which partitions the account can access. The role you choose may affect the partitions that one is allowed to specify. Specifically, roles such as `administrator`, `auditor` and `resource-administrator` require a `partition_access` of `all`. A set of pre-existing roles ship with the system. They are `none`, `guest`, `operator`, `application-editor`, `manager`, `certificate-manager`, `irule-manager`, `user-manager`, `resource-administrator`, `auditor`, `administrator`, and `firewall-manager`. \| \| attribute\_string string \| \| Specifies the user account attributes saved in the group, in the format `cn=, ou=, dc=`. When creating a new remote role, this parameter is required. \| \| line\_order integer \| \| Specifies the order of the line in the file `/config/bigip/auth/remoterole`. The LDAP and Active Directory servers read this file line by line. The order of the information is important; therefore, F5 recommends you set the first line at 1000. This allows you to insert lines before the first line in the future. When creating a new remote role, this parameter is required. \| \| name string / required \| \| Specifies the name of the remote role. \| \| partition\_access string \| \| Specifies the accessible partitions for the account. This parameter supports the reserved names `all` and `Common`, as well as specific partitions a user may access. Users who have access to a partition can operate on objects in that partition, as determined by the permissions conferred by the user's `assigned_role`. When creating a new remote role, if this parameter is not specified, the default is `all`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| remote\_access boolean \| Choices:* no * yes \| Enables or disables remote access for the specified group of remotely authenticated users. When creating a new remote role, if this parameter is not specified, the default is `yes`. \| \| state string \| Choices:* absent * present ← \| When `present`, guarantees the remote role exists. When `absent`, removes the remote role from the system. \| \| terminal\_access string \| \| Specifies terminal-based accessibility for remote accounts not already explicitly assigned a user role. Common values for this include `tmsh` and `none`, but you can also specify custom values. When creating a new remote role, if this parameter is not specified, the default is `none`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a remote role bigip_remote_role: name: foo group_name: ldap_group line_order: 1 attribute_string: memberOf=cn=ldap_group,cn=ldap.group,ou=ldap remote_access: enabled assigned_role: administrator partition_access: all terminal_access: none state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| assigned\_role string \| changed \| System role this remote role is associated with. Sample: administrator \| \| attribute\_string string \| changed \| The new attribute string of the resource. Sample: memberOf=cn=ldap\_group,cn=ldap.group,ou=ldap \| \| line\_order integer \| changed \| Order of the remote role for LDAP and Active Directory servers. Sample: 1000 \| \| partition\_access string \| changed \| Partition the role has access to. Sample: all \| \| remote\_access boolean \| changed \| Whether remote access is allowed or not. \| \| terminal\_access string \| changed \| The terminal setting of the remote role. Sample: tmsh \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_snat_pool – Manage SNAT pools on a BIG-IP f5networks.f5\_modules.bigip\_snat\_pool – Manage SNAT pools on a BIG-IP ======================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_snat_pool`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage SNAT pools on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| An optional description of the SNAT pool. \| \| members list / elements=string \| \| List of members to put in the SNAT pool. When `state` is `present`, this parameter is required, otherwise it is optional. The members can be either IP addresses or names of the SNAT translation objects. aliases: member \| \| name string / required \| \| The name of the SNAT pool. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| Whether the SNAT pool should exist or not. \| Notes ----- Note * When the `bigip_snat_pool` object is removed, it also removes any associated `bigip_snat_translation` objects. * This is a BIG-IP behavior not module behavior, and it only occurs when the `bigip_snat_translation` objects are also not referenced by another `bigip_snat_pool`. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add the SNAT pool 'my-snat-pool' bigip_snat_pool: name: my-snat-pool state: present members: - 10.10.10.10 - 20.20.20.20 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Change the SNAT pool's members to a single member bigip_snat_pool: name: my-snat-pool state: present member: 30.30.30.30 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove the SNAT pool 'my-snat-pool' bigip_snat_pool: name: johnd state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add the SNAT pool 'my-snat-pool' with a description bigip_snat_pool: name: my-snat-pool state: present members: - 10.10.10.10 - 20.20.20.20 description: A SNAT pool description provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| members list / elements=string \| changed and success \| List of members that are part of the SNAT pool. Sample: ['10.10.10.10'] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_gtm_monitor_external – Manages external GTM monitors on a BIG-IP f5networks.f5\_modules.bigip\_gtm\_monitor\_external – Manages external GTM monitors on a BIG-IP ================================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_monitor_external`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages external GTM (now BIG-IP DNS) monitors on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| arguments string \| \| Specifies any command-line arguments the script requires. \| \| external\_program string \| \| Specifies the name of the file for the monitor to use. In order to reference a file, you must first import it using options on the System > File Management > External Monitor Program File List > Import screen. The BIG-IP system automatically places the file in the proper location on the file system. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value will be 30. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be '\'. \| \| name* string / required \| \| Specifies the name of the monitor. \| \| parent string \| Default:"/Common/external" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `http` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. Note that if specifying an IP address, you must use a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value will be 120. \| \| variables dictionary \| \| Specifies any variables the script requires. Double quotes in values will be suppressed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an external monitor bigip_gtm_monitor_external: name: foo state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Create an external monitor with variables bigip_gtm_monitor_external: name: foo timeout: 10 variables: var1: foo var2: bar state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add a variable to an existing set bigip_gtm_monitor_external: name: foo timeout: 10 variables: var1: foo var2: bar cat: dog state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: external \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_device_dns – Manage DNS settings on a BIG-IP f5networks.f5\_modules.bigip\_device\_dns – Manage DNS settings on a BIG-IP =========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_dns`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the DNS settings on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cache string \| Choices:* enabled * disabled * enable * disable \| Specifies whether the system caches DNS lookups or performs the operation each time a lookup is needed. Note this applies only to Access Policy Manager (APM) features, such as ACLs, web application rewrites, and authentication. \| \| ip\_version integer \| Choices:* 4 * 6 \| Specifies whether the DNS specifies IP addresses using IPv4 or IPv6. \| \| name\_servers list / elements=string \| \| A list of name servers the system uses to validate DNS lookups \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| search list / elements=string \| \| A list of domains the system searches for local domain lookups, to resolve local host names. \| \| state string \| Choices:* absent * present ← \| The state of the variable on the system. When `present`, guarantees an existing variable is set to `value`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set the DNS settings on the BIG-IP bigip_device_dns: name_servers: - 208.67.222.222 - 208.67.220.220 search: - localdomain - lab.local provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cache string \| changed \| The new value of the DNS caching. Sample: enabled \| \| ip\_version integer \| changed \| IP version that was set, DNS will specify IP addresses in this version. Sample: 4 \| \| name\_servers list / elements=string \| changed \| List of name servers that were set. Sample: ['192.0.2.10', '172.17.12.10'] \| \| search list / elements=string \| changed \| List of search domains that were set. Sample: ['192.0.2.10', '172.17.12.10'] \| \| warnings list / elements=string \| always \| The list of warnings (if any) generated by module based on arguments Sample: ['...', '...'] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_asm_policy_import – Manage BIG-IP ASM policy imports f5networks.f5\_modules.bigip\_asm\_policy\_import – Manage BIG-IP ASM policy imports ==================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_asm_policy_import`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the policy imports for BIG-IP ASM policies. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| base64 boolean \| Choices:* no * yes \| Indicates if the imported policy string is encoded in Base64. This parameter only takes effect when using the `inline` method of import. \| \| encoding string \| Choices:* windows-874 * utf-8 * koi8-r * windows-1253 * iso-8859-10 * gbk * windows-1256 * windows-1250 * iso-8859-13 * iso-8859-9 * windows-1251 * iso-8859-6 * big5 * gb2312 * iso-8859-1 * windows-1252 * iso-8859-4 * iso-8859-2 * iso-8859-3 * gb18030 * shift\_jis * iso-8859-8 * euc-kr * iso-8859-5 * iso-8859-7 * windows-1255 * euc-jp * iso-8859-15 * windows-1257 * iso-8859-16 * auto-detect \| Specifies the desired application language of the imported policy. The imported policy cannot be a `parent` type or attached to a `parent` policy when `auto-detect` encoding is set. When importing a policy to attach to a `parent` policy, the `encoding` of the imported policy, if different, must be set to be the same value as `parent_policy`, otherwise import will fail. This parameter is available on TMOS version 13.x and later and only takes effect when the `inline` import method is used. \| \| force boolean \| Choices:* no ← * yes \| When set to `yes`, any existing policy with the same name will be overwritten by the new import. This works for both inline and file imports, if the policy does not exist this setting is ignored. \| \| inline string \| \| When specified, the ASM policy is created from a provided string. Content needs to be provided in a valid XML format, otherwise the operation will fail. \| \| name string / required \| \| The ASM policy to create or override. \| \| parent\_policy string \| \| The parent policy to which the newly imported policy should be attached as child. When `parent_policy` is specified, the imported `policy_type` must not be `parent`. This parameter is available on TMOS version 13.x and later and only takes effect when `inline` import method is used. \| \| partition string \| Default:"Common" \| Device partition on which to create the policy. This parameter is also applied to indicate the partition of the `parent` policy. \| \| policy\_type string \| Choices:* security ← * parent \| The type of the policy to import. When `policy_type` is `security`, the policy is imported as an application security policy that you can apply to a virtual server. When `policy_type` is `parent`, the policy becomes a parent to which other Security policies attach, inheriting its attributes. This policy type cannot be applied to Virtual Servers. This parameter is available on TMOS version 13.x and later and only takes effect when the `inline` import method is used. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| retain\_inheritance\_settings boolean \| Choices:* no * yes \| Indicates if an imported security type policy should retain settings when attached to parent policy. This parameter is available on TMOS version 13.x and later and only takes effect when the `inline` import method is used. \| \| source path \| \| Full path to a policy file to be imported into the BIG-IP ASM. Policy files exported from newer versions of BIG-IP cannot be imported into older versions of BIG-IP. However, policy files from older versions of BIG-IP can be imported into newer versions of BIG-IP. The file format can be binary or XML. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Import ASM policy bigip_asm_policy_import: name: new_asm_policy file: /root/asm_policy.xml provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Import ASM policy inline bigip_asm_policy_import: name: foo-policy4 inline: <xml>content</xml> provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Override existing ASM policy bigip_asm_policy: name: new_asm_policy source: /root/asm_policy_new.xml force: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| base64 boolean \| changed \| Indicates if the imported policy string is encoded in Base64. Sample: True \| \| encoding string \| changed \| The desired application language of the imported policy. Sample: utf-8 \| \| force boolean \| changed \| Set when overwriting an existing policy. Sample: True \| \| inline string \| changed \| Contents of a policy as an inline string. Sample: <xml>foobar contents</xml> \| \| name string \| changed \| Name of the ASM policy to be created/overwritten. Sample: Asm\_APP1\_Transparent \| \| parent\_policy string \| changed \| The parent policy to which the newly imported policy should be attached as child. Sample: /Common/parent \| \| policy\_type string \| changed \| The type of the policy to import. Sample: security \| \| retain\_inheritance\_settings boolean \| changed \| Indicate if an imported security type policy should retain settings when attached to the parent policy. Sample: True \| \| source string \| changed \| Local path to an ASM policy file. Sample: /root/some\_policy.xml \| ### Authors * Wojciech Wypior (@wojtek0806) * Nitin Khanna (@nitinthewiz) ansible f5networks.f5_modules.bigip_device_sshd – Manage the SSHD settings of a BIG-IP f5networks.f5\_modules.bigip\_device\_sshd – Manage the SSHD settings of a BIG-IP ================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_sshd`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the SSHD (secure shell daemon) settings of a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allow list / elements=string \| \| If you have enabled SSH access, specifies the IP address or address range for other systems that can use SSH to communicate with this system. To specify all addresses, use the value `all`. An IP address can be specified, such as 172.27.1.10. IP ranges can be specified, such as 172.27.\.\ or 172.27.0.0/255.255.0.0. To remove SSH access, specify an empty list or an empty string. \| \| banner string \| Choices:* enabled * disabled \| Whether to enable the banner or not. \| \| banner\_text string \| \| Specifies the text to include on the pre-login banner, which displays when a user attempts to login to the system using SSH. \| \| inactivity\_timeout integer \| \| Specifies the number of seconds before inactivity causes an SSH session to log out. \| \| log\_level string \| Choices:* debug * debug1 * debug2 * debug3 * error * fatal * info * quiet * verbose \| Specifies the minimum SSHD message level to include in the system log. \| \| login string \| Choices:* enabled * disabled \| When checked `enabled`, specifies the system accepts SSH communication. \| \| port integer \| \| Port on which you want the SSH daemon to run. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * Requires BIG-IP version 12.0.0 or greater * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set the banner for the SSHD service from a string bigip_device_sshd: banner: enabled banner_text: banner text goes here provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set the banner for the SSHD service from a file bigip_device_sshd: banner: enabled banner_text: "{{ lookup('file', '/path/to/file') }}" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Set the SSHD service to run on port 2222 bigip_device_sshd: port: 2222 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| allow list / elements=string \| changed \| If you have enabled SSH access, specifies the IP address or address range for other systems that can use SSH to communicate with this system. Sample: 192.0.2.\* \| \| banner string \| changed \| Whether the banner is enabled or not. Sample: True \| \| banner\_text string \| changed and success \| Specifies the text included on the pre-login banner which displays when a user attempts to login to the system using SSH. Sample: This is a corporate device. Connecting to it without... \| \| inactivity\_timeout integer \| changed \| The number of seconds before inactivity causes an SSH session to log out. Sample: 10 \| \| log\_level string \| changed \| The minimum SSHD message level to include in the system log. Sample: debug \| \| login boolean \| changed \| Specifies whether the system accepts SSH communications or not. Sample: True \| \| port integer \| changed \| Port on which you want the SSH daemon to run. Sample: 22 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_software_image – Manage software images on a BIG-IP f5networks.f5\_modules.bigip\_software\_image – Manage software images on a BIG-IP ================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_software_image`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages software images on a BIG-IP. These images may include both base images and hotfix images. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| force boolean \| Choices:* no ← * yes \| When `yes`, uploads the file every time and replaces the file on the device. When `no`, the file is only uploaded if it does not already exist. Generally should be `yes` only in cases where you have reason to believe the image was corrupted during upload. \| \| image string / required \| \| The image to put on the remote device. This may be an absolute or relative location on the Ansible controller. Image names, whether they are base ISOs or hotfix ISOs, must be unique. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* absent * present ← \| When `present`, ensures the image is uploaded. When `absent`, ensures the image is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Upload relative image to the BIG-IP bigip_software_image: image: BIGIP-13.0.0.0.0.1645.iso provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Upload absolute image to the BIG-IP bigip_software_image: image: /path/to/images/BIGIP-13.0.0.0.0.1645.iso provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Upload image in a role to the BIG-IP bigip_software_image: image: "{{ role_path }}/files/BIGIP-13.0.0.0.0.1645.iso" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| build string \| changed \| Build version of the software contained in the image. Sample: 0.0.3 \| \| checksum string \| changed \| MD5 checksum of the ISO. Sample: 8cdbd094195fab4b2b47ff4285577b70 \| \| file\_size integer \| changed \| Size of the uploaded image in MB. Sample: 1948 \| \| image\_type string \| changed \| Whether the image is a release or hotfix image. Sample: release \| \| version string \| changed \| Version of the software contained in the image. Sample: 13.1.0.8 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_device_auth_radius – Manages RADIUS auth configuration on a BIG-IP device f5networks.f5\_modules.bigip\_device\_auth\_radius – Manages RADIUS auth configuration on a BIG-IP device ========================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_auth_radius`. New in version 1.3.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Module creates a RADIUS configuration. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accounting\_bug boolean \| Choices:* no * yes \| Enables or disables validation of the accounting response vector. This option should be necessary only on older servers. \| \| fallback\_to\_local boolean \| Choices:* no * yes \| Specifies the system uses the Local authentication method if the remote authentication method is not available. Option only available on `TMOS 13.0.0` and above. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| retries integer \| \| Specifies the number of authentication retries the BIG-IP Local Traffic Management system allows before authentication fails. \| \| servers list / elements=string \| \| Specifies the names of RADIUS servers for use with RADIUS authentication profiles. \| \| service\_type string \| Choices:* authenticate-only * login * default * framed * callback-login * callback-framed * outbound * administrative * nas-prompt * callback-nas-prompt * call-check * callback-administrative \| Specifies the type of service requested from the RADIUS server. The default value is `authenticate-only`. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the RADIUS server exists. When `state` is `absent`, ensures the RADIUS server is removed. \| \| use\_for\_auth boolean \| Choices:* no * yes \| Specifies whether or not this auth source is put in use on the system. If `yes`, the module sets the current system auth type to the value of `radius`. If `no`, the module sets the authentication type to `local`, similar behavior to when `state` is `absent`, without removing the configured RADIUS resource. \| Notes ----- Note * This module is based on the command line (TMSH) configuration capabilities of RADIUS authentication, not the GUI. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an RADIUS device configuration bigip_device_auth_radius: servers: - "ansible_test1" - "ansible_test2" retries: 3 service_type: authenticate-only accounting_bug: no use_for_auth: yes fallback_to_local: yes state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update an RADIUS device configuration bigip_device_auth_radius: retries: 5 service_type: administrative accounting_bug: yes state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Delete RADIUS auth configuration bigip_device_auth_radius: state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| accounting\_bug boolean \| changed \| Enables or disables validation of the accounting response vector. Sample: True \| \| retries integer \| changed \| Number of authentication retries before authentication fails. Sample: 10 \| \| servers list / elements=string \| changed \| The servers value of the resource. Sample: hash/dictionary of values \| \| service\_type string \| changed \| Type of service requested from the RADIUS server. Sample: login \| ### Authors * Andrey Kashcheev (@andreykashcheev) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_pool_member – Manages F5 BIG-IP LTM pool members f5networks.f5\_modules.bigip\_pool\_member – Manages F5 BIG-IP LTM pool members =============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_pool_member`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM pool members via the REST API. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| IP address of the pool member. This can be either IPv4 or IPv6. When creating a new pool member, one of either `address` or `fqdn` must be provided. This parameter cannot be updated after it is set. aliases: ip, host \| \| aggregate list / elements=dictionary \| \| List of pool member definitions to be created, modified, or removed. When using `aggregates`, if one of the aggregate definitions is invalid, the aggregate run will fail, indicating the error it last encountered. The module will NOT rollback any changes it has made prior to encountering the error. The module also will not indicate what changes were made prior to failure. Therefore we strong advise you run the module in `check` mode to ensure basic validation prior to executing this module. aliases: members \| \| availability\_requirements dictionary \| \| If you activate more than one health monitor, specifies the number of health monitors that must receive successful responses in order for the link to be considered available. Specifying an empty string will remove the monitors and revert to inheriting from the pool (default). Specifying `none` will remove any health monitoring from the member completely. \| \| \| at\_least integer \| \| Specifies the minimum number of active health monitors that must be successful before the link is considered up. This parameter is only relevant when a `type` of `at_least` is used. This parameter will be ignored if a type of `all` is used. \| \| \| type string / required \| Choices:* all * at\_least \| Monitor rule type when `monitors` is specified. When creating a new pool, if this value is not specified, the default of `all` will be used. \| \| connection\_limit integer \| \| Pool member connection limit. Setting this to `0` disables the limit. \| \| description string \| \| Pool member description. \| \| fqdn string \| \| FQDN name of the pool member. This can be any name that is a valid RFC 1123 DNS name. Therefore, the only characters that can be used are "A" to "Z", "a" to "z", "0" to "9", the hyphen ("-") and the period ("."). FQDN names must include at least one period; delineating the host from the domain. For example, `host.domain`. FQDN names must end with a letter or a number. When creating a new pool member, one of either `address` or `fqdn` must be provided. This parameter cannot be updated after it is set. aliases: hostname \| \| fqdn\_auto\_populate boolean \| Choices:* no * yes \| Specifies whether the system automatically creates ephemeral nodes using the IP addresses returned by the resolution of a DNS query for a node defined by an FQDN. When `yes`, the system generates an ephemeral node for each IP address returned in response to a DNS query for the FQDN of the node. Additionally, when a DNS response indicates the IP address of an ephemeral node no longer exists, the system deletes the ephemeral node. When `no`, the system resolves a DNS query for the FQDN of the node with the single IP address associated with the FQDN. When creating a new pool member, the default for this parameter is `yes`. Once set this parameter cannot be changed afterwards. This parameter is ignored when `reuse_nodes` is `yes`. \| \| ip\_encapsulation string \| \| Specifies the IP encapsulation using either IPIP (IP encapsulation within IP, RFC 2003) or GRE (Generic Router Encapsulation, RFC 2784) on outbound packets (from BIG-IP system to server-pool member). When `none`, disables IP encapsulation. When `inherit`, inherits the IP encapsulation setting from the member's pool. When any other value, the options are None, Inherit from Pool, and Member Specific. \| \| monitors list / elements=string \| \| Specifies the health monitors the system currently uses to monitor this resource. \| \| name string \| \| Name of the node to create, or re-use, when creating a new pool member. This parameter is optional. If not specified, a node name will be created automatically from either the specified `address` or `fqdn`. The `enabled` state is an alias of `present`. \| \| partition string \| Default:"Common" \| Partition to manage resources on. \| \| pool string / required \| \| Pool name. This pool must exist. \| \| port integer \| \| Pool member port. This value cannot be changed after it has been set. Parameter must be provided when using aggregates. \| \| preserve\_node boolean \| Choices:* no * yes \| When state is `absent`, the system attempts to remove the node the pool member references. The node will not be removed if it is still referenced by other pool members. If this happens, the module will not raise an error. Setting this to `yes` disables this behavior. \| \| priority\_group integer \| \| Specifies a number representing the priority group for the pool member. When adding a new member, the default is `0`, meaning the member has no priority. To specify a priority, you must activate priority group usage when you create a new pool or when adding or removing pool members. When activated, the system load balances traffic according to the priority group number assigned to the pool member. The higher the number, the higher the priority. So a member with a priority of 3 has higher priority than a member with a priority of 1. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rate\_limit integer \| \| Pool member rate limit (connections-per-second). Setting this to `0` disables the limit. \| \| ratio integer \| \| Pool member ratio weight. Valid values range from 1 through 100. New pool members -- unless overridden with this value -- default to 1. \| \| replace\_all\_with boolean \| Choices:* no ← * yes \| Removes members not defined in the `aggregate` parameter. This operation is all or none, meaning it will stop if there are some pool members that cannot be removed. aliases: purge \| \| reuse\_nodes boolean \| Choices:* no * yes ← \| Reuses node definitions if requested. \| \| state string \| Choices:* present ← * absent * enabled * disabled * forced\_offline \| Pool member state. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add pool member bigip_pool_member: pool: my-pool partition: Common host: "{{ ansible_default_ipv4['address'] }}" port: 80 description: web server connection_limit: 100 rate_limit: 50 ratio: 2 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Modify pool member ratio and description bigip_pool_member: pool: my-pool partition: Common host: "{{ ansible_default_ipv4['address'] }}" port: 80 ratio: 1 description: nginx server provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove pool member from pool bigip_pool_member: state: absent pool: my-pool partition: Common host: "{{ ansible_default_ipv4['address'] }}" port: 80 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Force pool member offline bigip_pool_member: state: forced_offline pool: my-pool partition: Common host: "{{ ansible_default_ipv4['address'] }}" port: 80 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create members with priority groups bigip_pool_member: pool: my-pool partition: Common host: "{{ item.address }}" name: "{{ item.name }}" priority_group: "{{ item.priority_group }}" port: 80 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost loop: - address: 1.1.1.1 name: web1 priority_group: 4 - address: 2.2.2.2 name: web2 priority_group: 3 - address: 3.3.3.3 name: web3 priority_group: 2 - address: 4.4.4.4 name: web4 priority_group: 1 - name: Add pool members aggregate bigip_pool_member: pool: my-pool aggregate: - host: 192.168.1.1 partition: Common port: 80 description: web server connection_limit: 100 rate_limit: 50 ratio: 2 - host: 192.168.1.2 partition: Common port: 80 description: web server connection_limit: 100 rate_limit: 50 ratio: 2 - host: 192.168.1.3 partition: Common port: 80 description: web server connection_limit: 100 rate_limit: 50 ratio: 2 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add pool members aggregate, remove non aggregates bigip_pool_member: pool: my-pool aggregate: - host: 192.168.1.1 partition: Common port: 80 description: web server connection_limit: 100 rate_limit: 50 ratio: 2 - host: 192.168.1.2 partition: Common port: 80 description: web server connection_limit: 100 rate_limit: 50 ratio: 2 - host: 192.168.1.3 partition: Common port: 80 description: web server connection_limit: 100 rate_limit: 50 ratio: 2 replace_all_with: yes provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address string \| changed \| The address of the pool member. Sample: 1.2.3.4 \| \| connection\_limit integer \| changed \| The new connection limit of the pool member. Sample: 1000 \| \| description string \| changed \| The new description of pool member. Sample: My pool member \| \| fqdn string \| changed \| The FQDN of the pool member. Sample: foo.bar.com \| \| fqdn\_auto\_populate boolean \| changed \| Whether FQDN auto population was set on the member or not. Sample: True \| \| monitors list / elements=string \| changed \| The new list of monitors for the resource. Sample: ['/Common/monitor1', '/Common/monitor2'] \| \| priority\_group integer \| changed \| The new priority group. Sample: 3 \| \| rate\_limit integer \| changed \| The new rate limit, in connections per second, of the pool member. Sample: 100 \| \| ratio integer \| changed \| The new pool member ratio weight. Sample: 50 \| \| replace\_all\_with boolean \| changed \| Purges all non-aggregate pool members from device. Sample: True \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_user – Manage user accounts and user attributes on a BIG-IP f5networks.f5\_modules.bigip\_user – Manage user accounts and user attributes on a BIG-IP ========================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_user`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage user accounts and user attributes on a BIG-IP system. Typically this module operates only on REST API users and not CLI users. When specifying `root`, you may only change the password. Your other parameters are ignored in this case. Changing the `root` password is not an idempotent operation. Therefore, it changes the password every time this module attempts to change it. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| full\_name string \| \| Full name of the user. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| partition\_access list / elements=string \| \| Specifies the administrative partition to which the user has access. `partition_access` is required when creating a new account, and should be in the form "partition:role". Valid roles include `acceleration-policy-editor`, `admin`, `application-editor`, `auditor`, `certificate-manager`, `guest`, `irule-manager`, `manager`, `no-access`, `operator`, `resource-admin`, `user-manager`, `web-application-security-administrator`, and `web-application-security-editor`. The partition portion the of tuple should be an existing partition or the value 'all'. \| \| password\_credential string \| \| Set the users password to this unencrypted value. `password_credential` is required when creating a new account. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| shell string \| Choices:* bash * none * tmsh \| Optionally set the users shell. \| \| state string \| Choices:* present ← * absent \| Whether the account should exist or not, taking action if the state is different from what is stated. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` allows the user to update passwords. `on_create` only sets the password for newly created users. When `username_credential` is `root`, this value is forced to `always`. \| \| username\_credential string / required \| \| Name of the user to create, remove, or modify. The `root` user may not be removed. aliases: name \| Notes ----- Note * Requires BIG-IP versions >= 12.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add the user 'johnd' as an admin bigip_user: username_credential: johnd password_credential: password full_name: John Doe partition_access: - all:admin update_password: on_create state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Change the user "johnd's" role and shell bigip_user: username_credential: johnd partition_access: - NewPartition:manager shell: tmsh state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Make the user 'johnd' an admin and set to advanced shell bigip_user: name: johnd partition_access: - all:admin shell: bash state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove the user 'johnd' bigip_user: name: johnd state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Update password bigip_user: state: present username_credential: johnd password_credential: newsupersecretpassword provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost # Note that the second time this task runs, it would fail because # The password has been changed. Therefore, it is recommended that # you either, # # * Put this in its own playbook that you run when you need to # * Put this task in a `block` # * Include `ignore_errors` on this task - name: Change the Admin password bigip_user: state: present username_credential: admin password_credential: NewSecretPassword provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Change the root user's password bigip_user: username_credential: root password_credential: secret state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| full\_name string \| changed and success \| Full name of the user. Sample: John Doe \| \| partition\_access list / elements=string \| changed and success \| List of strings containing the user's roles and which partitions they are applied to. They are specified in the form "partition:role". Sample: ['all:admin'] \| \| shell string \| changed and success \| The shell assigned to the user account. Sample: tmsh \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_monitor_ldap – Manages BIG-IP LDAP monitors f5networks.f5\_modules.bigip\_monitor\_ldap – Manages BIG-IP LDAP monitors ========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_ldap`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IP LDAP monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| base string \| \| Specifies the location in the LDAP tree from which the monitor starts the health check. \| \| chase\_referrals boolean \| Choices:* no * yes \| Upon receipt of an LDAP referral entry, specifies whether the target follows (or chases) that referral. \| \| debug boolean \| Choices:* no * yes \| Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. \| \| description string \| \| Specifies descriptive text that identifies the monitor. \| \| filter string \| \| Specifies an LDAP key for which the monitor searches. \| \| interval integer \| \| Specifies the frequency, in seconds, at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| mandatory\_attributes* boolean \| Choices:* no * yes \| Specifies whether the target must include attributes in its response to be considered up. \| \| manual\_resume boolean \| Choices:* no * yes \| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to `yes`, you must manually re-enable the resource before the system can use it for load balancing connections. When `yes`, specifies you must manually re-enable the resource after an unsuccessful monitor check. When `no`, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. \| \| name string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/ldap" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `ldap` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. Note that if specifying an IP address, you must specify a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| security string \| Choices:* none * ssl * tls \| Specifies the secure protocol type for communication with the target. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password, if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name, if the monitored target requires authentication. \| \| time\_until\_up integer \| \| Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked 'up'. A value of 0 means the resource is marked up immediately upon receipt of the first correct response. \| \| timeout integer \| \| Specifies the number of seconds the target has in which to respond to the monitor request. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that `timeout` and `time_until_up` combine to control when a resource is set to up. \| \| up\_interval integer \| \| Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will update passwords if the `target_password` is specified. `on_create` will only set the password for newly created monitors. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a LDAP monitor bigip_monitor_ldap: name: foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| base string \| changed \| The new LDAP Base setting of the resource. Sample: base \| \| chase\_referrals boolean \| changed \| The new Chase Referrals setting of the resource. Sample: True \| \| debug boolean \| changed \| The new Debug setting of the resource. Sample: True \| \| description string \| changed \| The description of the monitor. Sample: Important\_Monitor \| \| filter string \| changed \| The new LDAP Filter setting of the resource. Sample: filter1 \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| mandatory\_attributes boolean \| changed \| The new Mandatory Attributes setting of the resource. \| \| manual\_resume boolean \| changed \| The new Manual Resume setting of the resource. \| \| parent string \| changed \| New parent template of the monitor. Sample: ldap \| \| security string \| changed \| The new Security setting of the resource. Sample: ssl \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Greg Crosby (@crosbygw) ansible f5networks.f5_modules.bigip_device_auth_radius_server – Manages the RADIUS server configuration of the device f5networks.f5\_modules.bigip\_device\_auth\_radius\_server – Manages the RADIUS server configuration of the device ================================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_auth_radius_server`. New in version 1.3.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages a device’s RADIUS server configuration. * Used in tandem with the `bigip_device_auth_radius` module. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description of the RADIUS server. \| \| ip string \| \| The IP address of the server. This parameter is mandatory when creating a new resource. \| \| name string / required \| \| Specifies the name of the RADIUS server to manage. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port integer \| \| The port of the server. Valid range of values is between `0` and `65535` inclusive. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| secret string \| \| Specifies the secret used for accessing RADIUS server. This parameter is mandatory when creating a new resource. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the RADIUS server exists. When `state` is `absent`, ensures the RADIUS server is removed. \| \| timeout integer \| \| Specifies the timeout value in seconds. Valid range of values is between `1` and `60` inclusive. \| \| update\_secret string \| Choices:* always ← * on\_create \| `always` will update passwords if the `secret` is specified. `on_create` will only set the password for newly created servers. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a RADIUS server configuration bigip_device_auth_radius_server: name: "ansible_test" ip: "1.1.1.1" port: 1812 secret: "secret" timeout: 5 update_secret: on_create state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update RADIUS server configuration bigip_device_auth_radius_server: name: "ansible_test" ip: "10.10.10.1" description: "this is a test" port: 1813 timeout: 10 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove RADIUS server configuration bigip_device_auth_radius_server: name: "ansible_test" state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| User defined description of the RADIUS server. Sample: this is my server \| \| ip string \| changed \| IP address of the RADIUS Server. Sample: 1.1.1.1 \| \| port integer \| changed \| RADIUS service port. Sample: 1812 \| \| timeout integer \| changed \| Timeout value. Sample: 3 \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_icmp – Manages F5 BIG-IP LTM ICMP monitors f5networks.f5\_modules.bigip\_monitor\_icmp – Manages F5 BIG-IP LTM ICMP monitors ================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_icmp`. New in version 1.1.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages ICMP monitors on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| adaptive boolean \| Choices:* no * yes \| Specifies whether adaptive response time monitoring is enabled for this monitor. When `yes`, the monitor determines the state of a service based on how divergent from the mean latency a monitor probe for that service is allowed to be. Also, values for the `allowed_divergence`, `adaptive_limit`, and and `sampling_timespan` will be enforced. When `disabled`, the monitor determines the state of a service based on the `interval`, `up_interval`, `time_until_up`, and `timeout` monitor settings. \| \| adaptive\_limit integer \| \| Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of `allowed_divergence` setting, for a probe to be considered successful. This value applies regardless of the value of the `allowed_divergence` setting. While this value can be configured when `adaptive` is `no`, it will not take effect on the system until `adaptive` is `yes`. \| \| allowed\_divergence\_type string \| Choices:* relative * absolute \| When specifying a new monitor, if `adaptive` is `yes`, the default is `relative`. When `absolute`, the number of milliseconds the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. In typical cases, if the monitor detects three probes in a row that miss the latency value you set, the pool member or node is marked down. When `relative`, the percentage of deviation the latency of a monitor probe can exceed the mean latency of a monitor probe for the service being probed. \| \| allowed\_divergence\_value integer \| \| When specifying a new monitor, if `adaptive` is `yes`, and `type` is `relative`, the default is `25` percent. \| \| app\_service string \| \| The iApp service to be associated with this profile. When no service is specified, the default is None. \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| Specifies the frequency, in seconds, at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. \| \| ip string \| \| Specifies the IP address of the resource that is the destination of this monitor. When set to \, the device performs a health check on the IP address of the node. When set to an <IP>* the device performs a health check on that IP address and marks the associated node up or down as a result of the response. This option is set by the device by default when not defined during monitor creation. When set to an <IP> and `transparent` is `yes`, the device performs a health check on that IP address, routes the check through the associated node IP address, and marks the associated node IP address up or down accordingly. \| \| manual\_resume boolean \| Choices:* no * yes \| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to `yes`, you must manually re-enable the resource before the system can use it for load balancing connections. When `yes`, specifies you must manually re-enable the resource after an unsuccessful monitor check. When `no`, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. \| \| name string / required \| \| Specifies the name of the monitor. \| \| parent string \| \| The parent template of this monitor template. Once this value has been set, it cannot be changed. When creating a new monitor, if this parameter is not specified, the default is the system-supplied `icmp` monitor. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| sampling\_timespan integer \| \| Specifies the length, in seconds, of the probe history window the system uses to calculate the mean latency and standard deviation of a monitor probe. While this value can be configured when `adaptive` is `no`, it will not take effect on the system until `adaptive` is `yes`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures that the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked 'up'. A value of 0 means the resource is marked up immediately upon receipt of the first correct response. \| \| timeout integer \| \| Specifies the number of seconds the target has in which to respond to the monitor request. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that `timeout` and `time_until_up` combine to control when a resource is set to up. \| \| transparent boolean \| Choices:* no * yes \| Specifies whether the monitor operates in transparent mode. A monitor in transparent mode directs traffic through the associated pool members or nodes (usually a router or firewall) to the aliased destination (that is, it probes the `ip`-`port` combination specified in the monitor). If the monitor cannot successfully reach the aliased destination, the pool member or node through which the monitor traffic was sent is marked down. When creating a new monitor, if this parameter is not provided, the default value will be whatever is provided by the `parent`. \| \| up\_interval integer \| \| Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an ICMP monitor bigip_monitor_icmp: name: icmp1 adaptive: no interval: 1 time_until_up: 0 timeout: 3 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update an ICMP monitor bigip_monitor_icmp: name: icmp1 manual_resume: yes interval: 5 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove an ICMP monitor bigip_monitor_icmp: name: icmp1 state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| adaptive boolean \| changed \| Whether adaptive is enabled or not. Sample: True \| \| adaptive\_limit integer \| changed \| Absolute number of milliseconds that may not be exceeded by a monitor probe. Sample: 200 \| \| allowed\_divergence\_type string \| changed \| Type of divergence used for adaptive response time monitoring. Sample: absolute \| \| allowed\_divergence\_value integer \| changed \| Value of the type of divergence used for adaptive response time monitoring. May be `percent` or `ms` depending on whether `relative` or `absolute`. Sample: 25 \| \| app\_service string \| changed \| The iApp service associated with this monitor. Sample: /Common/good\_service.app/good\_service \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: gateway-icmp \| \| port string \| changed \| Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Sample: 80 \| \| sampling\_timespan integer \| changed \| Absolute number of milliseconds that may not be exceeded by a monitor probe. Sample: 200 \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| transparent boolean \| changed \| Whether the monitor operates in transparent mode. \| \| up\_interval integer \| changed \| Interval for the system to use to perform the health check when a resource is up. \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_device_info – Collect information from F5 BIG-IP devices f5networks.f5\_modules.bigip\_device\_info – Collect information from F5 BIG-IP devices ======================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_info`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Collect information from F5 BIG-IP devices. * This module was called `bigip_device_facts` before Ansible 2.9. The usage did not change. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| gather\_subset list / elements=string / required \| Choices:* all * monitors * profiles * apm-access-profiles * apm-access-policies * as3 * asm-policy-stats * asm-policies * asm-server-technologies * asm-signature-sets * client-ssl-profiles * cfe * devices * device-groups * do * external-monitors * fasthttp-profiles * fastl4-profiles * gateway-icmp-monitors * gtm-pools * gtm-servers * gtm-wide-ips * gtm-a-pools * gtm-a-wide-ips * gtm-aaaa-pools * gtm-aaaa-wide-ips * gtm-cname-pools * gtm-cname-wide-ips * gtm-mx-pools * gtm-mx-wide-ips * gtm-naptr-pools * gtm-naptr-wide-ips * gtm-srv-pools * gtm-srv-wide-ips * gtm-topology-regions * http-monitors * https-monitors * http-profiles * iapp-services * iapplx-packages * icmp-monitors * interfaces * internal-data-groups * irules * ltm-pools * ltm-policies * management-routes * nodes * oneconnect-profiles * partitions * provision-info * remote-syslog * route-domains * self-ips * server-ssl-profiles * software-volumes * software-images * software-hotfixes * ssl-certs * ssl-keys * sync-status * system-db * system-info * ts * tcp-monitors * tcp-half-open-monitors * tcp-profiles * traffic-groups * trunks * udp-profiles * users * vcmp-guests * virtual-addresses * virtual-servers * vlans * !all * !as3 * !do * !ts * !cfe * !monitors * !profiles * !apm-access-profiles * !apm-access-policies * !asm-policy-stats * !asm-policies * !asm-server-technologies * !asm-signature-sets * !client-ssl-profiles * !devices * !device-groups * !external-monitors * !fasthttp-profiles * !fastl4-profiles * !gateway-icmp-monitors * !gtm-pools * !gtm-servers * !gtm-wide-ips * !gtm-a-pools * !gtm-a-wide-ips * !gtm-aaaa-pools * !gtm-aaaa-wide-ips * !gtm-cname-pools * !gtm-cname-wide-ips * !gtm-mx-pools * !gtm-mx-wide-ips * !gtm-naptr-pools * !gtm-naptr-wide-ips * !gtm-srv-pools * !gtm-srv-wide-ips * !gtm-topology-regions * !http-monitors * !https-monitors * !http-profiles * !iapp-services * !iapplx-packages * !icmp-monitors * !interfaces * !internal-data-groups * !irules * !ltm-pools * !ltm-policies * !management-routes * !nodes * !oneconnect-profiles * !partitions * !provision-info * !remote-syslog * !route-domains * !self-ips * !server-ssl-profiles * !software-volumes * !software-images * !software-hotfixes * !ssl-certs * !ssl-keys * !sync-status * !system-db * !system-info * !tcp-monitors * !tcp-half-open-monitors * !tcp-profiles * !traffic-groups * !trunks * !udp-profiles * !users * !vcmp-guests * !virtual-addresses * !virtual-servers * !vlans \| When supplied, this argument will restrict the information returned to a given subset. You can specify a list of values to include a larger subset. Values can also be used with an initial `!` to specify that a specific subset should not be collected. aliases: include \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Collect BIG-IP information bigip_device_info: gather_subset: - interfaces - vlans provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Collect all BIG-IP information bigip_device_info: gather_subset: - all provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Collect all BIG-IP information except trunks bigip_device_info: gather_subset: - all - "!trunks" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| apm\_access\_policies complex \| When `apm-access-policies` is specified in `gather_subset`. \| Information about APM Access Policies. \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/foo\_policy \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: foo\_policy \| \| apm\_access\_profiles complex \| When `apm-access-profiles` is specified in `gather_subset`. \| Information about APM Access Profiles. \| \| \| access\_policy string \| queried \| APM Access Policy attached to this Access Profile. Sample: foo\_policy \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/foo\_policy \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: foo\_policy \| \| asm\_policies complex \| When `asm-policies` is specified in `gather_subset`. \| Detailed information for ASM policies present on device. Sample: hash/dictionary of values \| \| \| active boolean \| queried \| Indicates if an ASM policy is active. In TMOS 13.x and above, this setting indicates if the policy is bound to any Virtual Server. Sample: True \| \| \| allowed\_response\_codes list / elements=string \| queried \| Lists the response status codes between 400 and 599 that the security profile considers legal. Sample: ['400', '404'] \| \| \| application\_language string \| queried \| The language encoding for the web application. Sample: utf-8 \| \| \| apply boolean \| queried \| In TMOS 13.x and above, this setting indicates if an ASM policy has pending changes that need to be applied. Sample: True \| \| \| case\_insensitive boolean \| queried \| Indicates if the ASM policy treats file types, URLs, and parameters as case sensitive. Sample: True \| \| \| csrf\_protection\_enabled boolean \| queried \| Specifies if CSRF protection is active on the ASM policy. Sample: True \| \| \| csrf\_protection\_expiration\_time\_in\_seconds integer \| queried \| Specifies how long, in seconds, a configured CSRF token is valid before it expires. Sample: 600 \| \| \| csrf\_protection\_ssl\_only boolean \| queried \| Specifies that only HTTPS URLs will be checked for CSRF protection. Sample: True \| \| \| csrf\_urls complex \| queried \| Specifies a list of URLs for CSRF token verification. In version 13.0.0 and later, this has become a sub-collection and a list of dictionaries. In version 12.x, this is a list of simple strings. \| \| \| \| csrf\_url string \| queried \| Specifies an URL to protect. Sample: ['/foo.html'] \| \| \| \| csrf\_url\_enforcement\_action string \| queried \| Indicates the action specified for the system to take when the URL entry matches. Sample: none \| \| \| \| csrf\_url\_id string \| queried \| Specifies the generated ID for the configured CSRF URL resource. Sample: l0Ckxe-7yHsXp8U5tTgbFQ \| \| \| \| csrf\_url\_method string \| queried \| Method for the specified URL. Sample: POST \| \| \| \| csrf\_url\_parameters\_list list / elements=string \| queried \| List of parameters to look for in a request when checking if the URL entry matches the request. Sample: ['fooparam'] \| \| \| \| csrf\_url\_required\_parameters string \| queried \| Indicates whether to ignore or require one of the specified parameters is present in a request when checking if the URL entry matches the request. Sample: ignore \| \| \| \| csrf\_url\_wildcard\_order string \| queried \| Specifies the order in which the wildcard URLs are enforced. Sample: 1 \| \| \| custom\_xff\_headers string \| queried \| List of custom XFF headers trusted by the system. Sample: asm-proxy1 \| \| \| description string \| queried \| Description of the resource. Sample: Significant Policy Description \| \| \| disallowed\_geolocations string \| queried \| Displays countries that may not access the web application. Sample: Argentina \| \| \| enforcement\_mode string \| queried \| Specifies whether blocking is active or inactive for the ASM policy. Sample: blocking \| \| \| enforcement\_readiness\_period integer \| queried \| Period in days both security policy entities and attack signatures remain in staging mode before the system suggests to enforce them. Sample: 8 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/foo\_policy \| \| \| has\_parent boolean \| queried \| Indicates if the ASM policy is a child of another ASM policy. \| \| \| inspect\_http\_uploads boolean \| queried \| Specifies whether the system should inspect all HTTP uploads. Sample: True \| \| \| learning\_mode string \| queried \| Determine how the policy is built. Sample: manual \| \| \| manual\_virtual\_servers list / elements=string \| queried \| The virtual servers that have Advanced LTM policy configuration which, in turn, have rule(s) built with ASM control actions enabled. Sample: ['/Common/test\_VS/'] \| \| \| mask\_credit\_card\_numbers\_in\_request boolean \| queried \| Indicates if the system masks credit card numbers. \| \| \| maximum\_cookie\_header\_length integer \| queried \| Maximum length of a cookie header name and value that the system processes. Sample: 8192 \| \| \| maximum\_http\_header\_length integer \| queried \| Maximum length of an HTTP header name and value that the system processes. Sample: 8192 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: foo\_policy \| \| \| path\_parameter\_handling string \| queried \| Specifies how the system handles path parameters that are attached to path segments in URIs. Sample: ignore \| \| \| place\_signatures\_in\_staging boolean \| queried \| Specifies if the system places new or updated signatures in staging for the number of days specified in the enforcement readiness period. \| \| \| policy\_id string \| queried \| Generated ID of the ASM policy resource. Sample: l0Ckxe-7yHsXp8U5tTgbFQ \| \| \| protocol\_independent boolean \| queried \| Indicates if the ASM policy differentiates between HTTP/WS and HTTPS/WSS URLs. \| \| \| signature\_staging boolean \| queried \| Specifies if the staging feature is active on the ASM policy. Sample: True \| \| \| trigger\_asm\_irule\_event string \| queried \| Indicates if iRule event is enabled. Sample: disabled \| \| \| trust\_xff boolean \| queried \| Indicates the system has confidence in an XFF (X-Forwarded-For) header in the request. Sample: True \| \| \| type string \| queried \| The type of policy, can be `Security` or `Parent`. Sample: security \| \| \| use\_dynamic\_session\_id\_in\_url boolean \| queried \| Specifies how the security policy processes URLs that use dynamic sessions. \| \| \| virtual\_servers list / elements=string \| queried \| Virtual server or servers which have this policy assigned to them. Sample: ['/Common/foo\_VS/'] \| \| asm\_policy\_stats complex \| When `asm-policy-stats` is specified in `gather_subset`. \| Miscellaneous ASM policy related information. Sample: hash/dictionary of values \| \| \| parent\_policies integer \| queried \| The total number of ASM parent policies on the device. Sample: 2 \| \| \| policies integer \| queried \| The total number of ASM policies on the device. Sample: 3 \| \| \| policies\_active integer \| queried \| The number of ASM policies that are marked as active. From TMOS 13.x and above this setting equals to `policies_attached`. Sample: 3 \| \| \| policies\_attached integer \| queried \| The number of ASM policies that are attached to virtual servers. Sample: 1 \| \| \| policies\_inactive integer \| queried \| The number of ASM policies that are marked as inactive. From TMOS 13.x and above this setting equals to `policies_unattached`. \| \| \| policies\_pending\_changes integer \| queried \| The total number of ASM policies with pending changes on the device. Sample: 2 \| \| \| policies\_unattached integer \| queried \| The number of ASM policies that are not attached to a virtual server. Sample: 3 \| \| asm\_server\_technologies complex \| When `asm-server-technologies` is specified in `gather_subset`. \| Detailed information for ASM server technologies present on the device. Sample: hash/dictionary of values \| \| \| id string \| queried \| Displays the generated ID for the server technology resource. Sample: l0Ckxe-7yHsXp8U5tTgbFQ \| \| \| server\_technology\_name string \| queried \| Friendly name of the server technology resource. Sample: Wordpress \| \| \| server\_technology\_references complex \| queried \| List of dictionaries containing API self links of the associated technology resources. \| \| \| \| link string \| queried \| A self link to an associated server technology. Sample: https://localhost/mgmt/tm/asm/server-technologies/NQG7CT02OBC2cQWbnP7T-A?ver=13.1.0 \| \| asm\_signature\_sets complex \| When `asm-signature-sets` is specified in `gather_subset`. \| Detailed information for ASM signature sets present on device. Sample: hash/dictionary of values \| \| \| assign\_to\_policy\_by\_default boolean \| queried \| Indicates whether the system assigns this signature set to a new created security policy by default. Sample: True \| \| \| category string \| queried \| Displays the category of the signature set. Sample: filter-based \| \| \| default\_alarm boolean \| queried \| Displays whether the security policy logs the request data in the Statistics screen if a request matches a signature that is included in the signature set. Sample: True \| \| \| default\_block boolean \| queried \| When the security policy enforcement mode is Blocking, displays how the system treats requests that match a signature included in the signature set. Sample: True \| \| \| default\_learn boolean \| queried \| Displays whether the security policy learns all requests that match a signature that is included in the signature set. Sample: True \| \| \| id string \| queried \| Displays the generated ID for the signature set resource. Sample: l0Ckxe-7yHsXp8U5tTgbFQ \| \| \| is\_user\_defined boolean \| queried \| Specifies this signature set was added by a user. \| \| \| name string \| queried \| Name of the signature set. Sample: WebSphere signatures \| \| \| type string \| queried \| The method used to select signatures to be a part of the signature set. Sample: filter-based \| \| client\_ssl\_profiles complex \| When `client-ssl-profiles` is specified in `gather_subset`. \| Client SSL Profile related information. Sample: hash/dictionary of values \| \| \| alert\_timeout integer \| queried \| Maximum time period, in seconds, to keep the SSL session active after an alert message is sent, or indefinite. \| \| \| allow\_non\_ssl boolean \| queried \| Enables or disables non-SSL connections. Sample: True \| \| \| authenticate\_depth integer \| queried \| Specifies the authenticate depth. This is the client certificate chain maximum traversal depth. Sample: 9 \| \| \| authenticate\_frequency string \| queried \| Specifies how often the system authenticates a user. Sample: once \| \| \| ca\_file string \| queried \| Specifies the certificate authority (CA) file name. Sample: /Common/default-ca.crt \| \| \| cache\_size integer \| queried \| Specifies the SSL session cache size. Sample: 262144 \| \| \| cache\_timeout integer \| queried \| Specifies the SSL session cache timeout value. Sample: 3600 \| \| \| certificate\_file string \| queried \| Specifies the name of the certificate installed on the traffic management system for the purpose of terminating or initiating an SSL connection. Sample: /Common/default.crt \| \| \| chain\_file string \| queried \| Specifies or builds a certificate chain file that a client can use to authenticate the profile. Sample: /Common/ca-chain.crt \| \| \| ciphers string \| queried \| Specifies a list of cipher names. Sample: ['DEFAULT'] \| \| \| crl\_file string \| queried \| Specifies the certificate revocation list file name. Sample: /Common/default.crl \| \| \| description string \| queried \| Description of the profile. Sample: My profile \| \| \| forward\_proxy\_ca\_certificate\_file string \| queried \| Specifies the name of the certificate file that is used as the certification authority certificate when SSL forward proxy feature is enabled. \| \| \| forward\_proxy\_ca\_key\_file string \| queried \| Specifies the name of the key file that is used as the certification authority key when SSL forward proxy feature is enabled. \| \| \| forward\_proxy\_ca\_passphrase string \| queried \| Specifies the passphrase of the key file that is used as the certification authority key when SSL forward proxy feature is enabled. \| \| \| forward\_proxy\_certificate\_extension\_include list / elements=string \| queried \| Specifies the extensions of the web server certificates to be included in the generated certificates using SSL Forward Proxy. Sample: ['basic-constraints', 'subject-alternative-name'] \| \| \| forward\_proxy\_certificate\_lifespan integer \| queried \| Specifies the lifespan of the certificate generated using the SSL forward proxy feature. Sample: 30 \| \| \| forward\_proxy\_enabled boolean \| queried \| Enables or disables SSL forward proxy feature. Sample: True \| \| \| forward\_proxy\_lookup\_by\_ipaddr\_port boolean \| queried \| Specifies whether to perform certificate look up by IP address and port number. \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/bigip02.internal \| \| \| handshake\_timeout integer \| queried \| Specifies the handshake timeout in seconds. Sample: 10 \| \| \| key\_file string \| queried \| Specifies the name of the key installed on the traffic management system for the purpose of terminating or initiating an SSL connection. Sample: /Common/default.key \| \| \| modssl\_methods boolean \| queried \| Enables or disables ModSSL method emulation. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: bigip02.internal \| \| \| parent string \| queried \| Parent of the profile Sample: /Common/clientssl \| \| \| peer\_certification\_mode string \| queried \| Specifies the peer certificate mode. Sample: ignore \| \| \| profile\_mode\_enabled boolean \| queried \| Specifies the profile mode, which enables or disables SSL processing. Sample: True \| \| \| renegotiation boolean \| queried \| Specifies whether renegotiations are enabled. Sample: True \| \| \| renegotiation\_maximum\_record\_delay integer \| queried \| Maximum number of SSL records that the traffic management system can receive before it renegotiates an SSL session. \| \| \| renegotiation\_period integer \| queried \| Number of seconds required to renegotiate an SSL session. \| \| \| retain\_certificate boolean \| queried \| APM module requires storing certificate in SSL session. When `no`, certificate will not be stored in SSL session. Sample: True \| \| \| secure\_renegotiation\_mode string \| queried \| Specifies the secure renegotiation mode. Sample: require \| \| \| server\_name string \| queried \| Specifies the server names to be matched with SNI (server name indication) extension information in ClientHello from a client connection. Sample: bigip01 \| \| \| session\_ticket boolean \| queried \| Enables or disables session-ticket. \| \| \| sni\_default boolean \| queried \| When `yes`, this profile is the default SSL profile when the server name in a client connection does not match any configured server names, or a client connection does not specify any server name at all. Sample: True \| \| \| sni\_require boolean \| queried \| When this option is `yes`, a client connection that does not specify a known server name or does not support SNI extension will be rejected. \| \| \| strict\_resume boolean \| queried \| Enables or disables strict-resume. Sample: True \| \| \| unclean\_shutdown boolean \| queried \| Whether to force the SSL profile to perform a clean shutdown of all SSL connections or not \| \| device\_groups complex \| When `device-groups` is specified in `gather_subset`. \| Device group related information. Sample: hash/dictionary of values \| \| \| asm\_sync\_enabled boolean \| queried \| Specifies whether to synchronize ASM configurations of device group members. Sample: True \| \| \| autosync\_enabled boolean \| queried \| Whether the device group automatically synchronizes configuration data to its members. \| \| \| description string \| queried \| Description of the device group. Sample: My device group \| \| \| devices list / elements=string \| queried \| List of devices in the group. Devices are listed by their `full_path`. Sample: ['/Common/bigip02.internal'] \| \| \| full\_load\_on\_sync boolean \| queried \| Specifies the entire configuration for a device group is sent when configuration synchronization is performed. Sample: True \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/fasthttp \| \| \| incremental\_config\_sync\_size\_maximum integer \| queried \| Specifies the maximum size (in KB) to devote to incremental config sync cached transactions. Sample: 1024 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: fasthttp \| \| \| network\_failover\_enabled boolean \| queried \| Specifies whether network failover is used. Sample: True \| \| \| type string \| queried \| Specifies the type of device group. Sample: sync-only \| \| devices complex \| When `devices` is specified in `gather_subset`. \| Device related information. Sample: hash/dictionary of values \| \| \| active\_modules list / elements=string \| queried \| The currently licensed and provisioned modules on the device. Sample: ['DNS Services (LAB)', 'PSM, VE'] \| \| \| base\_mac\_address string \| queried \| Media Access Control address (MAC address) of the device. Sample: fa:16:3e:c3:42:6f \| \| \| build string \| queried \| The minor version information of the total product version. Sample: 0.0.1 \| \| \| chassis\_id string \| queried \| Serial number of the device. Sample: 11111111-2222-3333-444444444444 \| \| \| chassis\_type string \| queried \| Displays the chassis type. The possible values are `individual` and `viprion`. Sample: individual \| \| \| comment string \| queried \| User comments about the device. Sample: My device \| \| \| configsync\_address string \| queried \| IP address used for configuration synchronization. Sample: 10.10.10.10 \| \| \| contact string \| queried \| Administrator contact information. Sample: The User \| \| \| description string \| queried \| Description of the device. Sample: My device \| \| \| edition string \| queried \| Displays the software edition. Sample: Point Release 7 \| \| \| failover\_state string \| queried \| Device failover state. Sample: active \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/bigip02.internal \| \| \| hostname string \| queried \| Device hostname Sample: bigip02.internal \| \| \| location string \| queried \| Specifies the physical location of the device. Sample: London \| \| \| management\_address string \| queried \| IP address of the management interface. Sample: 3.3.3.3 \| \| \| marketing\_name string \| queried \| Marketing name of the device platform. Sample: BIG-IP Virtual Edition \| \| \| multicast\_address string \| queried \| Specifies the multicast IP address used for failover. Sample: 4.4.4.4 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: bigip02.internal \| \| \| optional\_modules list / elements=string \| queried \| Modules that are available for the current platform, but are not currently licensed. Sample: ['App Mode (TMSH Only, No Root/Bash)', 'BIG-IP VE, Multicast Routing'] \| \| \| platform\_id string \| queried \| Displays the device platform identifier. Sample: Z100 \| \| \| primary\_mirror\_address string \| queried \| Specifies the IP address used for state mirroring. Sample: 5.5.5.5 \| \| \| product string \| queried \| Displays the software product name. Sample: BIG-IP \| \| \| secondary\_mirror\_address string \| queried \| Secondary IP address used for state mirroring. Sample: 2.2.2.2 \| \| \| self boolean \| queried \| Whether or not this device is the one that was queried for information. Sample: True \| \| \| software\_version string \| queried \| Displays the software version number. Sample: 13.1.0.7 \| \| \| timelimited\_modules list / elements=string \| queried \| Displays the licensed modules that are time-limited. Sample: ['IP Intelligence, 3Yr, ...', 'PEM URL Filtering, 3Yr, ...'] \| \| \| timezone string \| queried \| Displays the time zone configured on the device. Sample: UTC \| \| \| unicast\_addresses complex \| queried \| Specifies the entire set of unicast addresses used for failover. \| \| \| \| effective\_ip string \| queried \| The IP address that peers can use to reach this unicast address IP. Sample: 5.4.3.5 \| \| \| \| effective\_port integer \| queried \| The port that peers can use to reach this unicast address. Sample: 1026 \| \| \| \| ip string \| queried \| The IP address the failover daemon will listen on for packets from its peers. Sample: 5.4.3.5 \| \| \| \| port integer \| queried \| The IP port the failover daemon uses to accept packets from its peers. Sample: 1026 \| \| external\_monitors complex \| When `external-monitors` is specified in `gather_subset`. \| External monitor related information. Sample: hash/dictionary of values \| \| \| args string \| queried \| Specifies any command-line arguments the script requires. Sample: arg1 arg2 arg3 \| \| \| description string \| queried \| Description of the resource. Sample: My monitor \| \| \| destination string \| queried \| Specifies the IP address and service port of the resource that is the destination of this monitor. Sample: \:\ \| \| \| external\_program string \| queried \| Specifies the name of the file for the monitor to use. Sample: /Common/arg\_example \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/external \| \| \| interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. Sample: 5 \| \| \| manual\_resume boolean \| queried \| Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: external \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: external \| \| \| time\_until\_up integer \| queried \| Specifies the amount of time, in seconds, after the first successful response before a node is marked up. \| \| \| timeout integer \| queried \| Specifies the number of seconds the target has in which to respond to the monitor request. Sample: 16 \| \| \| up\_interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. \| \| \| variables dictionary \| success \| Specifies any variables the script requires. Sample: {'key1': 'val', 'key\_2': 'val 2'} \| \| fasthttp\_profiles complex \| When `fasthttp-profiles` is specified in `gather_subset`. \| FastHTTP profile related information. Sample: hash/dictionary of values \| \| \| client\_close\_timeout integer \| queried \| Number of seconds after which the system closes a client connection, when the system either receives a client FIN packet or sends a FIN packet to the client. Sample: 5 \| \| \| description string \| queried \| Description of the resource. Sample: My profile \| \| \| force\_http\_1\_0\_response boolean \| queried \| When `yes`, specifies the server sends responses to clients in the HTTP/1.0 format. \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/fasthttp \| \| \| http\_1\_1\_close\_workarounds boolean \| queried \| When `yes`, specifies the server uses workarounds for HTTP 1.1 close issues. \| \| \| idle\_timeout integer \| queried \| Length of time that a connection is idle (has no traffic) before the connection is eligible for deletion. Sample: 300 \| \| \| insert\_xforwarded\_for boolean \| queried \| Whether the system inserts the X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling. \| \| \| maximum\_header\_size integer \| queried \| Maximum amount of HTTP header data the system buffers before making a load balancing decision. Sample: 32768 \| \| \| maximum\_requests integer \| queried \| Maximum number of requests the system can receive on a client-side connection, before the system closes the connection. \| \| \| maximum\_segment\_size\_override integer \| queried \| Maximum segment size (MSS) override for server-side connections. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: fasthttp \| \| \| oneconnect\_idle\_timeout\_override integer \| queried \| Number of seconds after which a server-side connection in a OneConnect pool is eligible for deletion, when the connection has no traffic. \| \| \| oneconnect\_maximum\_pool\_size integer \| queried \| Maximum number of connections to a load balancing pool. Sample: 2048 \| \| \| oneconnect\_maximum\_reuse integer \| queried \| Maximum number of times the system can re-use a current connection. \| \| \| oneconnect\_minimum\_pool\_size integer \| queried \| Minimum number of connections to a load balancing pool. \| \| \| oneconnect\_ramp\_up\_increment integer \| queried \| The increment in which the system makes additional connections available, when all available connections are in use. Sample: 4 \| \| \| oneconnect\_replenish' boolean \| queried \| When `yes`, specifies the system will not keep a steady-state maximum of connections to the back-end, unless the number of connections to the pool have dropped beneath the `minimum_pool_size` specified in the profile. Sample: True \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: fasthttp \| \| \| receive\_window\_size integer \| queried \| Amount of data the BIG-IP system can accept without acknowledging the server. \| \| \| request\_header\_insert string \| queried \| A string the system inserts as a header in an HTTP request. If the header already exists, the system does not replace it. Sample: X-F5-Authentication: foo \| \| \| reset\_on\_timeout boolean \| queried \| When `yes`, specifies the system sends a reset packet (RST) in addition to deleting the connection, when a connection exceeds the idle timeout value. Sample: True \| \| \| server\_close\_timeout integer \| queried \| Number of seconds after which the system closes a client connection, when the system either receives a server FIN packet or sends a FIN packet to the server. Sample: 5 \| \| \| server\_sack boolean \| queried \| Whether the BIG-IP system processes Selective ACK (Sack) packets in cookie responses from the server. \| \| \| server\_timestamp boolean \| queried \| Whether the BIG-IP system processes timestamp request packets in cookie responses from the server. \| \| \| unclean\_shutdown string \| queried \| How the system handles closing connections. Values provided may be `enabled`, `disabled`, or `fast`. Sample: enabled \| \| fastl4\_profiles complex \| When `fastl4-profiles` is specified in `gather_subset`. \| FastL4 profile related information. Sample: hash/dictionary of values \| \| \| client\_timeout integer \| queried \| Specifies late binding client timeout in seconds. This is the number of seconds allowed for a client to transmit enough data to select a server pool. If this timeout expires, the timeout-recovery option dictates whether to drop the connection or fallback to the normal FastL4 load balancing method to pick a server pool. Sample: 30 \| \| \| description string \| queried \| Description of the resource. Sample: My profile \| \| \| dont\_fragment\_flag string \| queried \| Describes the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet. When `pmtu`, sets the outgoing IP Header DF bit based on the IP pmtu setting(tm.pathmtudiscovery). When `preserve`, sets the outgoing packet's IP Header DF bit to be the same as the incoming IP Header DF bit. When `set`, sets the outgoing packet's IP Header DF bit. When `clear`, clears the outgoing packet's IP Header DF bit. Sample: pmtu \| \| \| explicit\_flow\_migration boolean \| queried \| Specifies whether to have the iRule code determine exactly when the FIX stream drops down to the ePVA hardware. Sample: True \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/fastl4 \| \| \| generate\_init\_seq\_number boolean \| queried \| Specifies whether you want to generate TCP sequence numbers on all SYNs that conform with RFC1948, and allow timestamp recycling. Sample: True \| \| \| hardware\_syn\_cookie boolean \| queried \| Enables or disables hardware SYN cookie support when PVA10 is present on the system. This option is deprecated in version 13.0.0 and is replaced by `syn-cookie-enable`. \| \| \| idle\_timeout integer \| queried \| Specifies the number of seconds a connection is idle before the connection is eligible for deletion. Values are in the range of 0 to 4294967295 (inclusive). `0` is equivalent to the TMUI value "immediate". `4294967295` is equivalent to the TMUI value "indefinite". Sample: 300 \| \| \| ip\_tos\_to\_client string \| queried \| Specifies an IP Type of Service (ToS) number for the client-side. This option specifies the ToS level the traffic management system assigns to IP packets when sending them to clients. Sample: 200 \| \| \| ip\_tos\_to\_server string \| queried \| Specifies an IP ToS number for the server side. This option specifies the ToS level the traffic management system assigns to IP packets when sending them to servers. Sample: pass-through \| \| \| keep\_alive\_interval integer \| queried \| Specifies the keep-alive probe interval, in seconds. A value of 0 indicates keep-alive is disabled. Sample: 10 \| \| \| late\_binding boolean \| queried \| Specifies whether to enable or disable the intelligent selection of a back-end server pool. Sample: True \| \| \| link\_qos\_to\_client integer \| queried \| Specifies a Link Quality of Service (QoS) (VLAN priority) number for the client side. This option specifies the QoS level the system assigns to packets when sending them to clients. Sample: 7 \| \| \| link\_qos\_to\_server integer \| queried \| Specifies a Link QoS (VLAN priority) number for the server side. This option specifies the QoS level the system assigns to packets when sending them to servers. Sample: 5 \| \| \| loose\_close boolean \| queried \| Specifies the system closes a loosely-initiated connection when it receives the first FIN packet from either the client or the server. \| \| \| loose\_init boolean \| queried \| Specifies the system initializes a connection when it receives any Transmission Control Protocol (TCP) packet, rather than requiring a SYN packet for connection initiation. Sample: True \| \| \| mss\_override integer \| queried \| Specifies a maximum segment size (MSS) override for server connections. Note this is also the MSS advertised to a client when a client first connects. `0` (zero), means the option is disabled. Otherwise, the value will be between 256 and 9162. Sample: 500 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: fastl4 \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: fastl4 \| \| \| priority\_to\_client integer \| queried \| Specifies the internal packet priority for the client side. This option specifies the internal packet priority the system assigns to packets when sending them to clients. Sample: 300 \| \| \| priority\_to\_server integer \| queried \| Specifies the internal packet priority for the server side. This option specifies the internal packet priority the system assigns to packets when sending them to servers. Sample: 200 \| \| \| pva\_acceleration string \| queried \| Specifies the Packet Velocity(r) ASIC acceleration policy. Sample: full \| \| \| pva\_dynamic\_client\_packets integer \| queried \| Specifies the number of client packets before dynamic ePVA hardware re-offloading occurs. Values are between 0 and 10. Sample: 8 \| \| \| pva\_dynamic\_server\_packets integer \| queried \| Specifies the number of server packets before dynamic ePVA hardware re-offloading occurs. Values are between 0 and 10. Sample: 5 \| \| \| pva\_flow\_aging boolean \| queried \| Specifies if automatic aging from ePVA flow cache is enabled or not. Sample: True \| \| \| pva\_flow\_evict boolean \| queried \| Specifies if this flow can be evicted upon hash collision with a new flow learn snoop request. \| \| \| pva\_offload\_dynamic boolean \| queried \| Specifies whether PVA flow dynamic offloading is enabled or not. Sample: True \| \| \| pva\_offload\_state string \| queried \| Specifies at what stage the ePVA performs hardware offload. When `embryonic`, applies at TCP CSYN or the first client UDP packet. When `establish`, applies TCP 3WAY handshaking or UDP CS round trip are confirmed. Sample: embryonic \| \| \| reassemble\_fragments boolean \| queried \| Specifies whether to reassemble fragments. Sample: True \| \| \| receive\_window integer \| queried \| Specifies the window size to use, in bytes. The maximum is 2^31 for window scale enabling. Sample: 1000 \| \| \| reset\_on\_timeout boolean \| queried \| Specifies whether you want to reset connections on timeout. Sample: True \| \| \| rtt\_from\_client boolean \| queried \| Enables or disables the TCP timestamp options to measure the round trip time to the client. \| \| \| rtt\_from\_server boolean \| queried \| Enables or disables the TCP timestamp options to measure the round trip time to the server. Sample: True \| \| \| server\_sack boolean \| queried \| Specifies whether to support the server sack option in cookie responses by default. \| \| \| server\_timestamp boolean \| queried \| Specifies whether to support the server timestamp option in cookie responses by default. Sample: True \| \| \| software\_syn\_cookie boolean \| queried \| Enables or disables software SYN cookie support when PVA10 is not present on the system. This option is deprecated in version 13.0.0 and is replaced by `syn_cookie_enabled`. Sample: True \| \| \| strip\_sack boolean \| queried \| Specifies whether you want to block the TCP SackOK option from passing to the server on an initiating SYN. Sample: True \| \| \| syn\_cookie\_enabled boolean \| queried \| Enables syn-cookies capability on this virtual server. \| \| \| syn\_cookie\_mss integer \| queried \| Specifies a maximum segment size (MSS) for server connections when SYN Cookie is enabled. Sample: 2000 \| \| \| syn\_cookie\_whitelist boolean \| queried \| Specifies whether or not to use a SYN Cookie WhiteList when doing software SYN Cookies. \| \| \| tcp\_close\_timeout integer \| queried \| Specifies a TCP close timeout in seconds. Sample: 100 \| \| \| tcp\_handshake\_timeout integer \| queried \| Specifies a TCP handshake timeout in seconds. Sample: 5 \| \| \| tcp\_time\_wait\_timeout integer \| queried \| Specifies a TCP time\_wait timeout in milliseconds. Sample: 60 \| \| \| tcp\_timestamp\_mode string \| queried \| Specifies how you want to handle the TCP timestamp. Sample: preserve \| \| \| tcp\_window\_scale\_mode string \| queried \| Specifies how you want to handle the TCP window scale. Sample: preserve \| \| \| timeout\_recovery string \| queried \| Specifies late binding timeout recovery mode. This is the action to take when late binding timeout occurs on a connection. When `disconnect`, only the L7 iRule actions are acceptable to pick a server. When `fallback`, the normal FastL4 load balancing methods are acceptable to pick a server. Sample: fallback \| \| \| ttl\_mode string \| queried \| Describes the outgoing TCP packet's IP Header TTL mode. When `proxy`, sets the outgoing IP Header TTL value to 255/64 for IPv4/IPv6 respectively. When `preserve`, sets the outgoing IP Header TTL value to be same as the incoming IP Header TTL value. When `decrement`, sets the outgoing IP Header TTL value to be one less than the incoming TTL value. When `set`, sets the outgoing IP Header TTL value to a specific value (as specified by `ttl_v4` or `ttl_v6`. Sample: preserve \| \| \| ttl\_v4 integer \| queried \| Specifies the outgoing packet's IP Header TTL value for IPv4 traffic. Maximum value is 255. Sample: 200 \| \| \| ttl\_v6 integer \| queried \| Specify the outgoing packet's IP Header TTL value for IPv6. traffic. Maximum value is 255. Sample: 300 \| \| gateway\_icmp\_monitors complex \| When `gateway-icmp-monitors` is specified in `gather_subset`. \| Gateway ICMP monitor related information. Sample: hash/dictionary of values \| \| \| adaptive boolean \| queried \| Whether adaptive response time monitoring is enabled for this monitor. \| \| \| adaptive\_divergence\_type string \| queried \| Specifies whether the adaptive-divergence-value is `relative` or `absolute`. Sample: relative \| \| \| adaptive\_divergence\_value integer \| queried \| Specifies how far from mean latency each monitor probe is allowed to be. Sample: 25 \| \| \| adaptive\_limit integer \| queried \| Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. Sample: 200 \| \| \| adaptive\_sampling\_timespan integer \| queried \| Specifies the size of the sliding window, in seconds, which records probe history. Sample: 300 \| \| \| description string \| queried \| Description of the resource. Sample: My monitor \| \| \| destination string \| queried \| Specifies the IP address and service port of the resource that is the destination of this monitor. Sample: \:\ \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/gateway\_icmp \| \| \| interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. Sample: 5 \| \| \| manual\_resume boolean \| queried \| Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check. Sample: True \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: gateway\_icmp \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: gateway\_icmp \| \| \| time\_until\_up integer \| queried \| Specifies the amount of time, in seconds, after the first successful response before a node is marked up. \| \| \| timeout integer \| queried \| Specifies the number of seconds the target has in which to respond to the monitor request. Sample: 16 \| \| \| transparent boolean \| queried \| Specifies whether the monitor operates in transparent mode. \| \| \| up\_interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. \| \| gtm\_pools complex \| When any of `gtm-pools` or `gtm--pools` is specified in `gather_subset`. \| GTM pool related information. Every "type" of pool has the exact same list of possible information. Therefore, the list of information here is presented once instead of 6 times. Sample:* hash/dictionary of values \| \| \| alternate\_mode string \| queried \| The load balancing mode the system uses to load balance name resolution requests among the members of the pool. Sample: drop-packet \| \| \| disabled boolean \| queried \| Specifies the pool is disabled. \| \| \| dynamic\_ratio boolean \| queried \| Specifies whether the dynamic ratio load balancing algorithm is enabled for this pool. Sample: True \| \| \| enabled boolean \| queried \| Specifies the pool is enabled. \| \| \| fallback\_mode string \| queried \| Specifies the load balancing mode the system uses to load balance name resolution among the pool members if the preferred and alternate modes are unsuccessful in picking a pool. \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/pool1 \| \| \| load\_balancing\_mode string \| queried \| Specifies the preferred load balancing mode the system uses to load balance requests across pool members. \| \| \| manual\_resume boolean \| queried \| Whether manual resume is enabled for this pool. \| \| \| max\_answers\_returned integer \| queried \| Maximum number of available virtual servers the system lists in a response. \| \| \| members dictionary \| queried \| Lists of members (and their configurations) in the pool. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: pool1 \| \| \| partition string \| queried \| Partition on which the pool exists. \| \| \| qos\_hit\_ratio integer \| queried \| Weight of the Hit Ratio performance factor for the QoS dynamic load balancing method. \| \| \| qos\_hops integer \| queried \| Weight of the Hops performance factor when load balancing mode or fallback mode is QoS. \| \| \| qos\_kilobytes\_second integer \| queried \| Weight assigned to the Kilobytes per Second performance factor when the load balancing option is QoS. \| \| \| qos\_lcs integer \| queried \| Weight assigned to the Link Capacity performance factor when the load balacing option is QoS. \| \| \| qos\_packet\_rate integer \| queried \| Weight assigned to the Packet Rate performance factor when the load balacing option is QoS. \| \| \| qos\_rtt integer \| queried \| Weight assigned to the Round Trip Time performance factor when the load balacing option is QoS. \| \| \| qos\_topology integer \| queried \| Weight assigned to the Topology performance factor when the load balacing option is QoS. \| \| \| qos\_vs\_capacity integer \| queried \| Weight assigned to the Virtual Server performance factor when the load balacing option is QoS. \| \| \| qos\_vs\_score integer \| queried \| Weight assigned to the Virtual Server Score performance factor when the load balacing option is QoS. \| \| \| ttl integer \| queried \| Number of seconds the IP address, once found, is valid. \| \| \| verify\_member\_availability boolean \| queried \| Whether or not the system verifies the availability of the members before sending a connection to them. \| \| gtm\_servers complex \| When `gtm-servers` is specified in `gather_subset`. \| GTM server related information. Sample: hash/dictionary of values \| \| \| addresses dictionary \| queried \| Specifies the server IP addresses. \| \| \| datacenter string \| queried \| Full name of the datacenter to which this server belongs. \| \| \| devices dictionary \| queried \| Specifies the names of the devices that represent this server. \| \| \| disabled boolean \| queried \| Specifies the server is disabled. \| \| \| enabled boolean \| queried \| Specifies the server is enabled. \| \| \| expose\_route\_domains boolean \| queried \| Allow the GTM server to auto-discover the LTM virtual servers from all route domains. \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/server1 \| \| \| iq\_allow\_path boolean \| queried \| Whether the GTM uses this BIG-IP system to conduct a path probe before delegating traffic to it. \| \| \| iq\_allow\_service\_check boolean \| queried \| Whether the GTM uses this BIG-IP system to conduct a service check probe before delegating traffic to it. \| \| \| iq\_allow\_snmp boolean \| queried \| Whether the GTM uses this BIG-IP system to conduct an SNMP probe before delegating traffic to it. \| \| \| limit\_cpu\_usage integer \| queried \| For a server configured as a generic host, specifies the percent of CPU usage, otherwise this has no effect. \| \| \| limit\_cpu\_usage\_status boolean \| queried \| Whether `limit_cpu_usage` is enabled for this server. \| \| \| limit\_max\_bps integer \| queried \| Maximum allowable data throughput rate in bits per second for this server. \| \| \| limit\_max\_bps\_status boolean \| queried \| Whether `limit_max_bps` is enabled for this server. \| \| \| limit\_max\_connections integer \| queried \| Maximum number of concurrent connections, combined, for this server. \| \| \| limit\_max\_connections\_status boolean \| success \| Whether `limit_max_connections` is enabled for this server. \| \| \| limit\_max\_pps integer \| queried \| Maximum allowable data transfer rate for this server, in packets per second. \| \| \| limit\_max\_pps\_status boolean \| queried \| Whether `limit_max_pps` is enabled for this server. \| \| \| limit\_mem\_available integer \| queried \| For a server configured as a generic host, specifies the available memory required by the virtual servers on the server. If available memory falls below this limit, the system marks the server as unavailable. \| \| \| limit\_mem\_available\_status boolean \| queried \| Whether `limit_mem_available` is enabled for this server. \| \| \| link\_discovery string \| queried \| Specifies whether the system auto-discovers the links for this server. \| \| \| monitor\_type string \| queried \| Whether one or more monitors need to pass, or all monitors need to pass. Sample: and\_list \| \| \| monitors list / elements=string \| queried \| Specifies health monitors that the system uses to determine whether this server is available for load balancing. Sample: ['/Common/https\_443', '/Common/icmp'] \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: server1 \| \| \| prober\_fallback string \| queried \| The type of prober to use to monitor this server's resources when the preferred type is not available. \| \| \| prober\_preference string \| queried \| Specifies the type of prober to use to monitor this server's resources. \| \| \| product string \| queried \| Specifies the server type. \| \| \| virtual\_server\_discovery string \| queried \| Whether the system auto-discovers the virtual servers for this server. \| \| \| virtual\_servers dictionary \| queried \| Specifies the virtual servers that are resources for this server. \| \| gtm\_topology\_regions complex \| When `gtm-topology-regions` is specified in `gather_subset` \| GTM regions related information. Sample: hash/dictionary of values \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/region1 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: region1 \| \| \| region\_members complex \| success \| The list of region members. Sample: hash/dictionary of values \| \| \| \| continent string \| when configured for the region member. \| The name of one of the seven continents in ISO format, along with the `Unknown` setting. Sample: AF \| \| \| \| country string \| when configured for the region member. \| The country name returned as an ISO country code. Valid country codes can be found here https://countrycode.org/. Sample: US \| \| \| \| datacenter string \| when configured for the region member. \| The name of a GTM data center already defined in the configuration. Sample: /Common/dc1 \| \| \| \| geo\_isp string \| when configured for the region member. \| Specifies a geolocation ISP. Sample: /Common/FOO\_ISP \| \| \| \| isp string \| when configured for the region member. \| Specifies an Internet service provider. Sample: /Common/AOL \| \| \| \| negate boolean \| when configured for the region member. \| Indicates if the region member is a `IS-NOT` negative. In a BIG-IP configuration, the region members can be `IS` or `IS-NOT`. Sample: True \| \| \| \| pool string \| when configured for the region member. \| The name of a GTM pool already defined in the configuration. Sample: /Common/pool1 \| \| \| \| region string \| when configured for the region member. \| The name of region already defined in the configuration. Sample: /Common/region1 \| \| \| \| state string \| when configured for the region member. \| The state in a given country. Sample: AD/Sant Julia de Loria \| \| \| \| subnet string \| when configured for the region member. \| An IP address and network mask in the CIDR format. Sample: 10.10.10.0/24 \| \| gtm\_wide\_ips complex \| When any of `gtm-wide-ips` or `gtm--wide-ips` is specified in `gather_subset`. \| GTM Wide IP related information. Every "type" of Wide IP has the exact same list of possible information. Therefore, the list of information here is presented once instead of 6 times. Sample:* hash/dictionary of values \| \| \| description string \| queried \| Description of the Wide IP. \| \| \| disabled boolean \| queried \| Whether the Wide IP is disabled. \| \| \| enabled boolean \| queried \| Whether the Wide IP is enabled. \| \| \| failure\_rcode integer \| queried \| Specifies the DNS RCODE used when `failure_rcode_response` is `yes`. \| \| \| failure\_rcode\_response boolean \| queried \| When `yes`, specifies the system returns a RCODE response to Wide IP requests after exhausting all load balancing methods. \| \| \| failure\_rcode\_ttl integer \| queried \| Specifies the negative caching TTL of the SOA for the RCODE response. \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/wide1 \| \| \| last\_resort\_pool string \| queried \| Specifies which pool, as listed in Pool List, for the system to use as the last resort pool for the Wide IP. \| \| \| minimal\_response string \| queried \| Specifies the system forms the smallest allowable DNS response to a query. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: wide1 \| \| \| persist\_cidr\_ipv4 integer \| queried \| Specifies the number of bits the system uses to identify IPv4 addresses when persistence is enabled. \| \| \| persist\_cidr\_ipv6 integer \| queried \| Specifies the number of bits the system uses to identify IPv6 addresses when persistence is enabled. \| \| \| pool\_lb\_mode string \| queried \| Specifies the load balancing method used to select a pool in this Wide IP. \| \| \| pools dictionary \| queried \| Specifies the pools this Wide IP uses for load balancing. \| \| \| ttl\_persistence integer \| queried \| Specifies, in seconds, the length of time for which the persistence entry is valid. \| \| http\_monitors complex \| When `http-monitors` is specified in `gather_subset`. \| HTTP monitor related information. Sample: hash/dictionary of values \| \| \| adaptive boolean \| queried \| Whether adaptive response time monitoring is enabled for this monitor. \| \| \| adaptive\_divergence\_type string \| queried \| Specifies whether the adaptive-divergence-value is `relative` or `absolute`. Sample: relative \| \| \| adaptive\_divergence\_value integer \| queried \| Specifies how far from mean latency each monitor probe is allowed to be. Sample: 25 \| \| \| adaptive\_limit integer \| queried \| Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. Sample: 200 \| \| \| adaptive\_sampling\_timespan integer \| queried \| Specifies the size of the sliding window, in seconds, which records probe history. Sample: 300 \| \| \| description string \| queried \| Description of the resource. Sample: My monitor \| \| \| destination string \| queried \| Specifies the IP address and service port of the resource that is the destination of this monitor. Sample: \:\ \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/http \| \| \| interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. Sample: 5 \| \| \| ip\_dscp integer \| queried \| Specifies the differentiated services code point (DSCP). \| \| \| manual\_resume boolean \| queried \| Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check. Sample: True \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: http \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: http \| \| \| receive\_disable\_string string \| queried \| Specifies a text string the monitor looks for in the returned resource. If the text string is matched in the returned resource, the corresponding node or pool member is marked session disabled. Sample: check disable string \| \| \| receive\_string string \| queried \| Specifies the text string the monitor looks for in the returned resource. Sample: check string \| \| \| reverse boolean \| queried \| Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful check marks the monitored object down instead of up. \| \| \| send\_string string \| queried \| Specifies the text string the monitor sends to the target object. Sample: GET /\r\n \| \| \| time\_until\_up integer \| queried \| Specifies the amount of time, in seconds, after the first successful response before a node is marked up. \| \| \| timeout integer \| queried \| Specifies the number of seconds the target has in which to respond to the monitor request. Sample: 16 \| \| \| transparent boolean \| queried \| Specifies whether the monitor operates in transparent mode. \| \| \| up\_interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. \| \| \| username string \| queried \| Specifies the username, if the monitored target requires authentication. Sample: user1 \| \| http\_profiles complex \| When `http-profiles` is specified in `gather_subset`. \| HTTP profile related information. Sample: hash/dictionary of values \| \| \| accept\_xff boolean \| queried \| Enables or disables trusting the client IP address, and statistics from the client IP address, based on the request's X-Forwarded-For (XFF) headers, if they exist. Sample: True \| \| \| allow\_truncated\_redirects boolean \| queried \| Specifies the pass-through behavior when a redirect lacking the trailing carriage-return and line feed pair at the end of the headers is parsed. When `no`, the system will silently drop the invalid HTTP. \| \| \| default\_connect\_handling string \| queried \| Specifies the behavior of the proxy service when handling outbound requests. Sample: deny \| \| \| description string \| queried \| Description of the resource. Sample: My profile \| \| \| excess\_client\_headers string \| queried \| Specifies the pass-through behavior when the `max_header_count` value is exceeded by the client. When `reject`, the system rejects the connection. Sample: reject \| \| \| excess\_server\_headers string \| queried \| Specifies the pass-through behavior when `max_header_count` value is exceeded by the server. When `reject`, the system rejects the connection. Sample: reject \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/http \| \| \| hsts\_enabled boolean \| queried \| When `yes`, enables the HTTP Strict Transport Security settings. Sample: True \| \| \| hsts\_include\_subdomains boolean \| queried \| When `yes`, applies the HSTS policy to the HSTS host and its subdomains. Sample: True \| \| \| insert\_xforwarded\_for boolean \| queried \| When `yes`, specifies the system inserts an X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling. \| \| \| known\_methods list / elements=string \| queried \| Optimizes the behavior of a known HTTP method in the list. The default methods include the following HTTP/1.1 methods. CONNECT, DELETE, GET, HEAD, LOCK, OPTIONS, POST, PROPFIND, PUT, TRACE, UNLOCK. If a known method is deleted from the `known_methods` list, the BIG-IP system applies the `unknown_method` setting to manage that traffic. Sample: ['CONNECT', 'DELETE', '...'] \| \| \| lws\_max\_columns integer \| queried \| Specifies the maximum column width for any given line, when inserting an HTTP header in an HTTP request. Sample: 80 \| \| \| max\_header\_count integer \| queried \| Specifies the maximum number of headers the system supports. Sample: 64 \| \| \| max\_header\_size integer \| queried \| Specifies the maximum size, in bytes, the system allows for all HTTP request headers combined, including the request line. Sample: 32768 \| \| \| max\_requests integer \| queried \| Specifies the number of requests the system accepts on a per-connection basis. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: http \| \| \| onconnect\_transformations boolean \| queried \| When `yes`, specifies the system performs HTTP header transformations for the purpose of keeping connections open. Sample: True \| \| \| oversize\_client\_headers string \| queried \| Specifies the pass-through behavior when the `max_header_size` value is exceeded by the client. Sample: reject \| \| \| oversize\_server\_headers string \| queried \| Specifies the pass-through behavior when the `max_header_size` value is exceeded by the server. Sample: reject \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: http \| \| \| pipeline\_action string \| queried \| Enables or disables HTTP/1.1 pipelining. Sample: allow \| \| \| proxy\_mode string \| queried \| Specifies the proxy mode for this profile. Either reverse, explicit, or transparent. Sample: reverse \| \| \| redirect\_rewrite string \| queried \| Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses. Sample: none \| \| \| request\_chunking string \| queried \| Specifies how the system handles HTTP content that is chunked by a client. Sample: preserve \| \| \| response\_chunking string \| queried \| Specifies how the system handles HTTP content that is chunked by a server. Sample: selective \| \| \| server\_agent\_name string \| queried \| Specifies the string used as the server name in traffic generated by LTM. Sample: BigIP \| \| \| sflow\_poll\_interval integer \| queried \| The maximum interval in seconds between two pollings. \| \| \| sflow\_sampling\_rate integer \| queried \| Specifies the ratio of packets observed to the samples generated. \| \| \| unknown\_method string \| queried \| Specifies the behavior (allow, reject, or pass through) when an unknown HTTP method is parsed. Sample: allow \| \| \| via\_request string \| queried \| Specifies whether to Remove, Preserve, or Append Via headers included in a client request to an origin web server. Sample: preserve \| \| \| via\_response string \| queried \| Specifies whether to Remove, Preserve, or Append Via headers included in an origin web server response to a client. Sample: preserve \| \| https\_monitors complex \| When `https-monitors` is specified in `gather_subset`. \| HTTPS monitor related information. Sample: hash/dictionary of values \| \| \| adaptive boolean \| queried \| Whether adaptive response time monitoring is enabled for this monitor. \| \| \| adaptive\_divergence\_type string \| queried \| Specifies whether the adaptive-divergence-value is `relative` or `absolute`. Sample: relative \| \| \| adaptive\_divergence\_value integer \| queried \| Specifies how far from mean latency each monitor probe is allowed to be. Sample: 25 \| \| \| adaptive\_limit integer \| queried \| Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. Sample: 200 \| \| \| adaptive\_sampling\_timespan integer \| queried \| Specifies the size of the sliding window, in seconds, which records probe history. Sample: 300 \| \| \| description string \| queried \| Description of the resource. Sample: My monitor \| \| \| destination string \| queried \| Specifies the IP address and service port of the resource that is the destination of this monitor. Sample: \:\ \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/http \| \| \| interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. Sample: 5 \| \| \| ip\_dscp integer \| queried \| Specifies the differentiated services code point (DSCP). \| \| \| manual\_resume boolean \| queried \| Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: http \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: http \| \| \| receive\_disable\_string string \| queried \| Specifies a text string the monitor looks for in the returned resource. If the text string is matched in the returned resource, the corresponding node or pool member is marked session disabled. Sample: check disable string \| \| \| receive\_string string \| queried \| Specifies the text string the monitor looks for in the returned resource. Sample: check string \| \| \| reverse boolean \| queried \| Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful check marks the monitored object down instead of up. \| \| \| send\_string string \| queried \| Specifies the text string the monitor sends to the target object. Sample: GET /\r\n \| \| \| ssl\_profile string \| queried \| Specifies the SSL profile to use for the HTTPS monitor. Sample: /Common/serverssl \| \| \| time\_until\_up integer \| queried \| Specifies the amount of time, in seconds, after the first successful response before a node is marked up. \| \| \| timeout integer \| queried \| Specifies the number of seconds the target has in which to respond to the monitor request. Sample: 16 \| \| \| transparent boolean \| queried \| Specifies whether the monitor operates in transparent mode. \| \| \| up\_interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. \| \| \| username string \| queried \| Specifies the username, if the monitored target requires authentication. Sample: user1 \| \| iapp\_services complex \| When `iapp-services` is specified in `gather_subset`. \| iApp v1 service related information. Sample: hash/dictionary of values \| \| \| description string \| queried \| Description of the service. Sample: My service \| \| \| device\_group string \| queried \| The device group the iApp service is part of. Sample: /Common/dg1 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/service1 \| \| \| inherited\_device\_group boolean \| queried \| Whether the device group is inherited or not. Sample: True \| \| \| inherited\_traffic\_group boolean \| queried \| Whether the traffic group is inherited or not. Sample: True \| \| \| lists list / elements=string \| queried \| List of the lists data used to create the service. Sample: [{'name': 'irules\_\_irules'}, {'value': []}, '...'] \| \| \| metadata list / elements=string \| queried \| List of the metadata data used to create the service. Sample: [{'name': 'var1'}, {'persist': 'true'}, '...'] \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: service1 \| \| \| strict\_updates boolean \| queried \| Whether strict updates are enabled or not. Sample: True \| \| \| tables list / elements=string \| queried \| List of the tabular data used to create the service. Sample: [{'name': 'basic\_\_snatpool\_members'}, '...'] \| \| \| template\_modified boolean \| queried \| Whether template the service is based on is modified from its default value, or not. Sample: True \| \| \| traffic\_group string \| queried \| Traffic group the service is a part of. Sample: /Common/tg \| \| \| variables list / elements=string \| queried \| List of the variable data used to create the service. Sample: [{'name': 'afm\_\_policy'}, {'encrypted': 'no'}, {'value': '/#no\_not\_use#'}, '...'] \| \| icmp\_monitors complex \| When `icmp-monitors` is specified in `gather_subset`. \| ICMP monitor related information. Sample: hash/dictionary of values \| \| \| adaptive boolean \| queried \| Whether adaptive response time monitoring is enabled for this monitor. \| \| \| adaptive\_divergence\_type string \| queried \| Specifies whether the adaptive-divergence-value is `relative` or `absolute`. Sample: relative \| \| \| adaptive\_divergence\_value integer \| queried \| Specifies how far from mean latency each monitor probe is allowed to be. Sample: 25 \| \| \| adaptive\_limit integer \| queried \| Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. Sample: 200 \| \| \| adaptive\_sampling\_timespan integer \| queried \| Specifies the size of the sliding window, in seconds, which records probe history. Sample: 300 \| \| \| description string \| queried \| Description of the resource. Sample: My monitor \| \| \| destination string \| queried \| Specifies the IP address and service port of the resource that is the destination of this monitor. Sample: \:\ \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/icmp \| \| \| interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. Sample: 5 \| \| \| manual\_resume boolean \| success \| Specifies whether the system automatically changes the status of a resource to (B)up at the next successful monitor check. Sample: True \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: icmp \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: icmp \| \| \| time\_until\_up integer \| queried \| Specifies the amount of time, in seconds, after the first successful response before a node is marked up. \| \| \| timeout integer \| queried \| Specifies the number of seconds the target has in which to respond to the monitor request. Sample: 16 \| \| \| transparent boolean \| queried \| Specifies whether the monitor operates in transparent mode. \| \| \| up\_interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. \| \| interfaces complex \| When `interfaces` is specified in `gather_subset`. \| Interface related information. Sample: hash/dictionary of values \| \| \| active\_media\_type string \| queried \| Displays the current media setting for the interface. Sample: 100TX-FD \| \| \| bundle string \| queried \| The bundle capability on the port. Sample: not-supported \| \| \| bundle\_speed string \| queried \| The bundle-speed on the port when bundle capability is enabled. Sample: 100G \| \| \| description string \| queried \| Description of the interface. Sample: My interface \| \| \| enabled boolean \| queried \| Whether the interface is enabled or not. Sample: True \| \| \| flow\_control string \| queried \| Specifies how the system controls the sending of PAUSE frames for flow control. Sample: tx-rx \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/interface1 \| \| \| if\_index integer \| queried \| The index assigned to this interface. Sample: 32 \| \| \| lldp\_admin string \| queried \| Sets the sending or receiving of LLDP packets on that interface. Should be one of `disable`, `txonly`, `rxonly` or `txrx`. Sample: txonly \| \| \| mac\_address string \| queried \| Displays the 6-byte ethernet address in non-case-sensitive hexadecimal colon notation. Sample: 00:0b:09:88:00:9a \| \| \| media\_sfp string \| queried \| The settings for an SFP (pluggable) interface. Sample: auto \| \| \| mtu integer \| queried \| Displays the Maximum Transmission Unit (MTU) of the interface, which is the maximum number of bytes in a frame without IP fragmentation. Sample: 1500 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: interface1 \| \| \| prefer\_port string \| queried \| Indicates which side of a combo port the interface uses, if both sides of the port have the potential for external links. Sample: sfp \| \| \| sflow\_poll\_interval integer \| queried \| Specifies the maximum interval in seconds between two pollings. \| \| \| sflow\_poll\_interval\_global boolean \| queried \| Specifies whether the global interface poll-interval setting overrides the object-level poll-interval setting. Sample: True \| \| \| stp\_auto\_edge\_port boolean \| queried \| STP edge port detection. Sample: True \| \| \| stp\_enabled boolean \| queried \| Whether STP is enabled or not. \| \| \| stp\_link\_type string \| queried \| Specifies the STP link type for the interface. Sample: auto \| \| irules complex \| When `irules` is specified in `gather_subset`. \| iRule related information. Sample: hash/dictionary of values \| \| \| checksum string \| queried \| Checksum of the iRule as calculated by BIG-IP. Sample: d41d8cd98f00b204e9800998ecf8427e \| \| \| definition string \| queried \| The actual definition of the iRule. Sample: when HTTP\_REQUEST ... \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/irule1 \| \| \| ignore\_verification boolean \| queried \| Whether the verification of the iRule should be ignored or not. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: irule1 \| \| \| signature string \| queried \| The calculated signature of the iRule. Sample: WsYy2M6xMqvosIKIEH/FSsvhtWMe6xKOA6i7f... \| \| ltm\_policies complex \| When `ltm-policies` is specified in `gather_subset`. \| List of LTM (Local Traffic Manager) policies. Sample: hash/dictionary of values \| \| \| controls list / elements=string \| queried \| Aspects of the system controlled by this policy. Sample: ['forwarding'] \| \| \| description string \| queried \| Description of the policy. Sample: My policy \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/policy1 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: policy1 \| \| \| requires list / elements=string \| queried \| Aspects of the system required by this policy. Sample: ['http'] \| \| \| rules complex \| when rules are defined in the policy. \| List of LTM (Local Traffic Manager) policy rules. Sample: hash/dictionary of values \| \| \| \| actions complex \| when actions are defined in the rule. \| The actions the policy will take when a match is encountered. Sample: hash/dictionary of values \| \| \| \| \| http\_reply boolean \| when defined in the action. \| Indicates if the action affects a reply to a given HTTP request. Sample: True \| \| \| \| \| location string \| when defined in the action. \| This action will come from the given location. Sample: tcl:https://[getfield [HTTP::host] \":\" 1][HTTP::uri] \| \| \| \| \| redirect boolean \| when defined in the action. \| This action will redirect a request. \| \| \| \| \| request boolean \| when defined in the action. \| This policy action is performed on connection requests. \| \| \| \| conditions complex \| when conditions are defined in the rule. \| The conditions a policy will match on. Sample: hash/dictionary of values \| \| \| \| \| address boolean \| when defined in the condition. \| This condition matches on a TCP address. \| \| \| \| \| all boolean \| when defined in the condition. \| Matches all. Sample: True \| \| \| \| \| case\_insensitive boolean \| when defined in the condition. \| Specifies the value matched on is case insensitive. \| \| \| \| \| case\_sensitive boolean \| when defined in the condition. \| Specifies the value matched on is case sensitive. Sample: True \| \| \| \| \| contains\_string boolean \| when defined in the condition. \| Specifies the value matches if it contains a certain string. Sample: True \| \| \| \| \| datagroup string \| when defined in the condition. \| This condition matches on an HTTP URI. Sample: /Common/policy\_using\_datagroup \| \| \| \| \| external boolean \| when defined in the condition. \| Specifies the value matched on is from the external side of a connection. Sample: True \| \| \| \| \| http\_basic\_auth boolean \| when defined in the condition. \| This condition matches on basic HTTP authorization. \| \| \| \| \| http\_host boolean \| when defined in the condition. \| This condition matches on an HTTP host. Sample: True \| \| \| \| \| http\_uri boolean \| when defined in the condition. \| This condition matches on an HTTP URI. \| \| \| \| \| matches boolean \| when defined in the condition. \| This condition matches on an address. \| \| \| \| \| proxy\_connect boolean \| when defined in the condition. \| Specifies the value matched on is proxyConnect. \| \| \| \| \| proxy\_request boolean \| when defined in the condition. \| Specifies the value matched on is proxyRequest. \| \| \| \| \| remote boolean \| when defined in the condition. \| Specifies the value matched on is remote. \| \| \| \| \| request boolean \| when defined in the condition. \| This policy matches on a request. Sample: True \| \| \| \| \| tcp boolean \| when defined in the condition. \| This condition matches on TCP parameters. \| \| \| \| \| username boolean \| when defined in the condition. \| Matches on a username. Sample: True \| \| \| \| \| values list / elements=string \| when defined in the condition. \| The specified values will be matched on. Sample: ['foo.bar.com', 'baz.cool.com'] \| \| \| status string \| queried \| Indicates published or draft policy status. Sample: draft \| \| \| strategy string \| queried \| The match strategy for the policy. Sample: /Common/first-match \| \| ltm\_pools complex \| When `ltm-pools` is specified in `gather_subset`. \| List of LTM (Local Traffic Manager) pools. Sample: hash/dictionary of values \| \| \| active\_member\_count integer \| queried \| The number of active pool members in the pool. Sample: 3 \| \| \| all\_avg\_queue\_entry\_age integer \| queried \| Average queue entry age, for both the pool and its members. Sample: 5 \| \| \| all\_max\_queue\_entry\_age\_ever integer \| queried \| Maximum queue entry age ever, for both the pool and its members. Sample: 2 \| \| \| all\_max\_queue\_entry\_age\_recently integer \| queried \| Maximum queue entry age recently, for both the pool and its members. Sample: 5 \| \| \| all\_num\_connections\_queued\_now integer \| queried \| Number of connections queued now, for both the pool and its members. Sample: 20 \| \| \| all\_num\_connections\_serviced integer \| queried \| Number of connections serviced, for both the pool and its members. Sample: 15 \| \| \| all\_queue\_head\_entry\_age integer \| queried \| Queue head entry age, for both the pool and its members. Sample: 4 \| \| \| allow\_nat boolean \| queried \| Whether NATs are automatically enabled or disabled for any connections using this pool. Sample: True \| \| \| allow\_snat boolean \| queried \| Whether SNATs are automatically enabled or disabled for any connections using this pool. Sample: True \| \| \| availability\_status string \| queried \| The availability of the pool. Sample: offline \| \| \| available\_member\_count integer \| queried \| The number of available pool members in the pool. Sample: 4 \| \| \| client\_ip\_tos string \| queried \| Whether the system sets a Type of Service (ToS) level within a packet sent to the client, based on the targeted pool. Values can range from `0` to `255`, or be set to `pass-through` or `mimic`. Sample: pass-through \| \| \| client\_link\_qos string \| queried \| Whether the system sets a Quality of Service (QoS) level within a packet sent to the client, based on the targeted pool. Values can range from `0` to `7`, or be set to `pass-through`. Sample: pass-through \| \| \| current\_sessions integer \| queried \| Current sessions. Sample: 2 \| \| \| description string \| queried \| Description of the pool. Sample: my pool \| \| \| enabled\_status string \| queried \| The enabled status of the pool. Sample: enabled \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/pool1 \| \| \| ignore\_persisted\_weight boolean \| queried \| Specifies not to count the weight of persisted connections on pool members when making load balancing decisions. \| \| \| lb\_method string \| queried \| Load balancing method used by the pool. Sample: round-robin \| \| \| member\_count integer \| queried \| Total number of members in the pool. Sample: 50 \| \| \| members complex \| when members exist in the pool. \| List of LTM (Local Traffic Manager) pools. \| \| \| \| address string \| queried \| IP address of the pool member. Sample: 1.1.1.1 \| \| \| \| connection\_limit integer \| queried \| The maximum number of concurrent connections allowed for a pool member. \| \| \| \| description string \| queried \| The description of the pool member. Sample: pool member 1 \| \| \| \| dynamic\_ratio integer \| queried \| A range of numbers you want the system to use in conjunction with the ratio load balancing method. Sample: 1 \| \| \| \| encapsulation\_profile string \| queried \| The encapsulation profile to use for the pool member. Sample: ip4ip4 \| \| \| \| ephemeral boolean \| queried \| Whether the node backing the pool member is ephemeral or not. Sample: True \| \| \| \| fqdn\_autopopulate boolean \| queried \| Whether the node should scale to the IP address set returned by DNS. Sample: True \| \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Includes the port in the name. Sample: /Common/member:80 \| \| \| \| inherit\_profile boolean \| queried \| Whether the pool member inherits the encapsulation profile from the parent pool. \| \| \| \| logging boolean \| queried \| Whether the monitor applied should log its actions. \| \| \| \| monitors list / elements=string \| queried \| The Monitors active on the pool member. Monitor names are in their "full\_path" form. Sample: ['/Common/http'] \| \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: member:80 \| \| \| \| partition string \| queried \| Partition the member exists on. Sample: Common \| \| \| \| priority\_group integer \| queried \| The priority group within the pool for this pool member. \| \| \| \| rate\_limit boolean \| queried \| The maximum number of connections per second allowed for a pool member. \| \| \| \| ratio integer \| queried \| The weight of the pool for load balancing purposes. Sample: 1 \| \| \| \| session string \| queried \| Enables or disables the pool member for new sessions. Sample: monitor-enabled \| \| \| \| state string \| queried \| Controls the state of the pool member, overriding any monitors. Sample: down \| \| \| metadata dictionary \| queried \| Dictionary of arbitrary key/value pairs set on the pool. Sample: hash/dictionary of values \| \| \| minimum\_active\_members integer \| queried \| Whether the system load balances traffic according to the priority number assigned to the pool member. This parameter is identical to `priority_group_activation` and is just an alias for it. Sample: 2 \| \| \| minimum\_up\_members integer \| queried \| The minimum number of pool members that must be up. Sample: 1 \| \| \| minimum\_up\_members\_action string \| queried \| The action to take if the `minimum_up_members_checking` is enabled and the number of active pool members falls below the number specified in `minimum_up_members`. Sample: failover \| \| \| minimum\_up\_members\_checking boolean \| queried \| Enables or disables the `minimum_up_members` feature. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: pool1 \| \| \| pool\_avg\_queue\_entry\_age integer \| queried \| Average queue entry age, for the pool only. Sample: 5 \| \| \| pool\_max\_queue\_entry\_age\_ever integer \| queried \| Maximum queue entry age ever, for the pool only. Sample: 2 \| \| \| pool\_max\_queue\_entry\_age\_recently integer \| queried \| Maximum queue entry age recently, for the pool only. Sample: 5 \| \| \| pool\_num\_connections\_queued\_now integer \| queried \| Number of connections queued now, for the pool only. Sample: 20 \| \| \| pool\_num\_connections\_serviced integer \| queried \| Number of connections serviced, for the pool only. Sample: 15 \| \| \| pool\_queue\_head\_entry\_age integer \| queried \| Queue head entry age, for the pool only. Sample: 4 \| \| \| priority\_group\_activation integer \| queried \| Whether the system load balances traffic according to the priority number assigned to the pool member. This parameter is identical to `minimum_active_members` and is just an alias for it. Sample: 2 \| \| \| queue\_depth\_limit integer \| queried \| The maximum number of connections that may simultaneously be queued to go to any member of this pool. Sample: 3 \| \| \| queue\_on\_connection\_limit boolean \| queried \| Enable or disable queuing connections when pool member or node connection limits are reached. Sample: True \| \| \| queue\_time\_limit integer \| queried \| Specifies the maximum time, in milliseconds, a connection will remain queued. \| \| \| real\_session string \| queried \| The actual REST API value for the `session` attribute. This is different from the `state` return value, as the return value can be considered a generalization of all available sessions, instead of the specific value of the session. Sample: monitor-enabled \| \| \| real\_state string \| queried \| The actual REST API value for the `state` attribute. This is different from the `state` return value, as the return value can be considered a generalization of all available states, instead of the specific value of the state. Sample: up \| \| \| reselect\_tries integer \| queried \| The number of times the system tries to contact a pool member after a passive failure. \| \| \| server\_ip\_tos string \| queried \| The Type of Service (ToS) level to use when sending packets to a server. Sample: pass-through \| \| \| server\_link\_qos string \| queried \| The Quality of Service (QoS) level to use when sending packets to a server. Sample: pass-through \| \| \| server\_side\_bits\_in integer \| queried \| Number of server-side ingress bits. Sample: 1000 \| \| \| server\_side\_bits\_out integer \| queried \| Number of server-side egress bits. Sample: 200 \| \| \| server\_side\_current\_connections integer \| queried \| Number of current connections server-side. Sample: 300 \| \| \| server\_side\_max\_connections integer \| queried \| Maximum number of connections server-side. Sample: 40 \| \| \| server\_side\_pkts\_in integer \| queried \| Number of server-side ingress packets. Sample: 1098384 \| \| \| server\_side\_pkts\_out integer \| queried \| Number of server-side egress packets. Sample: 3484734 \| \| \| server\_side\_total\_connections integer \| queried \| Total number of server-side connections. Sample: 24 \| \| \| service\_down\_action string \| queried \| The action to take if the service specified in the pool is marked down. Sample: none \| \| \| slow\_ramp\_time integer \| queried \| The ramp time for the pool. This provides the ability for a pool member that is newly enabled or marked up to receive proportionally less traffic than other members in the pool. Sample: 10 \| \| \| status\_reason string \| queried \| If there is a problem with the status of the pool, it is reported here. Sample: The children pool member(s) are down. \| \| \| total\_requests integer \| queried \| Total requests. Sample: 8 \| \| management\_routes complex \| When `management-routes` is specified in `gather_subset`. \| Management route related information. Sample: hash/dictionary of values \| \| \| description string \| queried \| User defined description of the route. Sample: route-1-external \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/default \| \| \| gateway string \| queried \| The gateway IP address through which the system forwards packets to the destination. Sample: 192.168.0.1 \| \| \| mtu string \| queried \| The maximum transmission unit for the management interface. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: default \| \| \| network string \| queried \| The destination subnet and netmask, also specified as default or default-inet6. Sample: default \| \| nodes complex \| When `nodes` is specified in `gather_subset`. \| Node related information. Sample: hash/dictionary of values \| \| \| address string \| queried \| IP address of the node. Sample: 2.3.4.5 \| \| \| availability\_status string \| queried \| The availability of the node. Sample: offline \| \| \| connection\_limit integer \| queried \| Maximum number of connections the node can handle. Sample: 100 \| \| \| description string \| queried \| Description of the node. Sample: My node \| \| \| dynamic\_ratio integer \| queried \| Dynamic ratio number for the node used when doing `Dynamic Ratio` load balancing. Sample: 200 \| \| \| enabled\_status string \| queried \| The enabled status of the node. Sample: enabled \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/5.6.7.8 \| \| \| monitor\_rule string \| queried \| A string representation of the full monitor rule. Sample: /Common/https\_443 and /Common/icmp \| \| \| monitor\_status string \| queried \| Status of the node as reported by the monitor(s) associated with it. This value is also used in determining node `state`. Sample: down \| \| \| monitor\_type string \| queried \| The `monitor_type` field related to the `bigip_node` module, for this nodes monitors. Sample: and\_list \| \| \| monitors list / elements=string \| queried \| A list of the monitors identified in the `monitor_rule`. Sample: ['/Common/https\_443', '/Common/icmp'] \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: 5.6.7.8 \| \| \| rate\_limit integer \| queried \| Maximum number of connections per second allowed for the node. Sample: 1000 \| \| \| ratio integer \| queried \| Fixed size ratio used for node during `Ratio` load balancing. Sample: 10 \| \| \| session\_status string \| queried \| This value is also used in determining node `state`. Sample: enabled \| \| \| status\_reason string \| queried \| If there is a problem with the status of the node, it is reported here. Sample: /Common/https\_443 No successful responses received... \| \| oneconnect\_profiles complex \| When `oneconnect-profiles` is specified in `gather_subset`. \| OneConnect profile related information. Sample: hash/dictionary of values \| \| \| description string \| queried \| Description of the resource. Sample: My profile \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/oneconnect \| \| \| idle\_timeout\_override integer \| queried \| Specifies the number of seconds that a connection is idle before the connection flow is eligible for deletion. Sample: 1000 \| \| \| limit\_type string \| queried \| When `none`, simultaneous in-flight requests and responses over TCP connections to a pool member are counted toward the limit. When `idle`, idle connections will be dropped as the TCP connection limit is reached. When `strict`, the TCP connection limit is honored with no exceptions. This means idle connections will prevent new TCP connections from being made until they expire, even if they could otherwise be reused. Sample: idle \| \| \| max\_age integer \| queried \| Specifies the maximum age, in seconds, of a connection in the connection reuse pool. Sample: 100 \| \| \| max\_reuse integer \| queried \| Specifies the maximum number of times a server connection can be reused. Sample: 1000 \| \| \| max\_size integer \| queried \| Specifies the maximum number of connections the system holds in the connection reuse pool. If the pool is already full, then the server connection closes after the response is completed. Sample: 1000 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: oneconnect \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: oneconnect \| \| \| share\_pools boolean \| queried \| Indicates connections may be shared not only within a virtual server, but also among similar virtual servers. Sample: True \| \| \| source\_mask string \| queried \| Specifies a source IP mask. If no mask is provided, the value `any6` is used. Sample: 255.255.255.0 \| \| partitions complex \| When `partitions` is specified in `gather_subset`. \| Partition related information. Sample: hash/dictionary of values \| \| \| default\_route\_domain integer \| queried \| ID of the route domain that is associated with the IP addresses that reside in the partition. \| \| \| description string \| queried \| Description of the partition. Sample: Tenant 1 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: Common \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: Common \| \| provision\_info complex \| When `provision-info` is specified in `gather_subset`. \| Module provisioning related information. Sample: hash/dictionary of values \| \| \| cpu\_ratio integer \| queried \| Ratio of CPU allocated to this module. Only relevant if `level` was specified as `custom`. Otherwise, this value will be reported as `0`. \| \| \| disk\_ratio integer \| queried \| Ratio of disk allocated to this module. Only relevant if `level` was specified as `custom`. Otherwise, this value will be reported as `0`. \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: asm \| \| \| level integer \| queried \| Provisioned level of the module on BIG-IP. Valid return values can include `none`, `minimum`, `nominal`, `dedicated` and `custom`. \| \| \| memory\_ratio integer \| queried \| Ratio of memory allocated to this module. Only relevant if `level` was specified as `custom`. Otherwise, this value will be reported as `0`. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: asm \| \| remote\_syslog complex \| When `remote-syslog` is specified in `gather_subset`. \| Remote Syslog related information. Sample: hash/dictionary of values \| \| \| servers complex \| queried \| Configured remote syslog servers. Sample: hash/dictionary of values \| \| \| \| local\_ip string \| queried \| The local IP address of the remote syslog server. Sample: 10.10.10.10 \| \| \| \| name string \| queried \| Name of remote syslog server as configured on the system. Sample: /Common/foobar1 \| \| \| \| remote\_host string \| queried \| The IP address or hostname of the remote syslog server. Sample: 192.168.1.1 \| \| \| \| remote\_port integer \| queried \| Remote port of the remote syslog server. Sample: 514 \| \| route\_domains complex \| When `self-ips` is specified in `gather_subset`. \| Route domain related information. Sample: hash/dictionary of values \| \| \| bwc\_policy string \| queried \| The bandwidth controller for the route domain. Sample: /Common/foo \| \| \| connection\_limit integer \| queried \| The new connection limit for the route domain. Sample: 100 \| \| \| description string \| queried \| Description of the Route Domain. Sample: My route domain \| \| \| flow\_eviction\_policy string \| queried \| The new eviction policy to use with this route domain. Sample: /Common/default-eviction-policy \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/rd1 \| \| \| id integer \| queried \| The unique identifying integer representing the route domain. Sample: 10 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: rd1 \| \| \| parent string \| queried \| The route domain the system searches when it cannot find a route in the configured domain. \| \| \| routing\_protocol list / elements=string \| queried \| List of routing protocols applied to the route domain. Sample: ['bfd', 'bgp'] \| \| \| service\_policy string \| queried \| The new service policy to use with this route domain. Sample: /Common-my-service-policy \| \| \| strict string \| queried \| The new strict isolation setting. Sample: enabled \| \| \| vlans list / elements=string \| queried \| List of new VLANs the route domain is applied to. Sample: ['/Common/http-tunnel', '/Common/socks-tunnel'] \| \| self\_ips complex \| When `self-ips` is specified in `gather_subset`. \| Self IP related information. Sample: hash/dictionary of values \| \| \| allow\_access\_list list / elements=string \| queried \| List of protocols, and optionally their ports, that are allowed to access the Self IP. Also known as port-lockdown in the web interface. Items in the list are in the format of "protocol:port". Some items may not have a port associated with them and in those cases the port is `0`. Sample: ['tcp:80', 'egp:0'] \| \| \| description string \| queried \| Description of the Self IP. Sample: My self-ip \| \| \| floating boolean \| queried \| Whether the Self IP is a floating address or not. Sample: True \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/self1 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: self1 \| \| \| netmask string \| queried \| Netmask portion of the IP address, in dotted notation. Sample: 255.255.255.0 \| \| \| netmask\_cidr integer \| queried \| Netmask portion of the IP address, in CIDR notation. Sample: 24 \| \| \| service\_policy string \| queried \| Service policy assigned to the Self IP. Sample: /Common/service1 \| \| \| traffic\_group string \| queried \| Traffic group the Self IP is associated with. Sample: /Common/traffic-group-local-only \| \| \| traffic\_group\_inherited boolean \| queried \| Whether or not the traffic group is inherited. \| \| \| vlan string \| queried \| VLAN associated with the Self IP. Sample: /Common/vlan1 \| \| server\_ssl\_profiles complex \| When `server-ssl-profiles` is specified in `gather_subset`. \| Server SSL related information. Sample: hash/dictionary of values \| \| \| alert\_timeout string \| queried \| Maximum time period in seconds to keep the SSL session active after an alert message is sent, or indefinite. Sample: 100 \| \| \| allow\_expired\_crl boolean \| queried \| Use the specified CRL file, even if it has expired. Sample: True \| \| \| authenticate\_depth integer \| queried \| The client certificate chain maximum traversal depth Sample: 9 \| \| \| authenticate\_name string \| queried \| Common Name (CN) embedded in a server certificate. The system authenticates a server based on the specified CN. Sample: foo \| \| \| authentication\_frequency string \| queried \| Specifies the frequency of authentication. Sample: once \| \| \| bypass\_on\_client\_cert\_fail boolean \| queried \| Enables or disables SSL forward proxy bypass on failing to get client certificate that the server asks for. Sample: True \| \| \| bypass\_on\_handshake\_alert boolean \| queried \| Enables or disables SSL forward proxy bypass on receiving handshake\_failure, protocol\_version or unsupported\_extension alert message during the serverside SSL handshake. \| \| \| c3d\_ca\_cert string \| queried \| Name of the certificate file used as the certification authority certificate when SSL client certificate constrained delegation is enabled. Sample: /Common/cacert.crt \| \| \| c3d\_ca\_key string \| queried \| Name of the key file used as the certification authority key when SSL client certificate constrained delegation is enabled. Sample: /Common/default.key \| \| \| c3d\_cert\_extension\_includes list / elements=string \| queried \| Extensions of the client certificates to be included in the generated certificates using SSL client certificate constrained delegation. Sample: ['basic-constraints', 'extended-key-usage', '...'] \| \| \| c3d\_cert\_lifespan integer \| queried \| Lifespan of the certificate generated using the SSL client certificate constrained delegation. Sample: 24 \| \| \| ca\_file string \| queried \| Certificate authority file name. Sample: default.crt \| \| \| cache\_size integer \| queried \| The SSL session cache size. Sample: 262144 \| \| \| cache\_timeout integer \| queried \| The SSL session cache timeout value, which is the usable lifetime seconds of negotiated SSL session IDs. Sample: 86400 \| \| \| cert string \| queried \| The name of the certificate installed on the traffic management system for the purpose of terminating or initiating an SSL connection. Sample: /Common/default.crt \| \| \| chain string \| queried \| Specifies or builds a certificate chain file that a client can use to authenticate the profile. Sample: /Common/default.crt \| \| \| cipher\_group string \| queried \| Specifies a cipher group. \| \| \| ciphers string \| queried \| Specifies a cipher name. Sample: DEFAULT \| \| \| crl\_file string \| queried \| Specifies the certificate revocation list file name. \| \| \| description string \| queried \| Description of the resource. Sample: My profile \| \| \| expire\_cert\_response\_control string \| queried \| Specifies the BIGIP action when the server certificate has expired. Sample: drop \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: serverssl \| \| \| generic\_alert boolean \| queried \| Enables or disables generic-alert. Sample: True \| \| \| handshake\_timeout string \| queried \| Specifies the handshake timeout in seconds. Sample: 10 \| \| \| key string \| queried \| Specifies the name of the key installed on the traffic management system for the purpose of terminating or initiating an SSL connection. Sample: /Common/default.key \| \| \| max\_active\_handshakes string \| queried \| Specifies the maximum number of allowed active SSL handshakes. Sample: 100 \| \| \| mod\_ssl\_methods boolean \| queried \| Enables or disables ModSSL methods. Sample: True \| \| \| mode boolean \| queried \| Enables or disables SSL processing. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: serverssl \| \| \| ocsp string \| queried \| Specifies the name of the OCSP profile for validating the status of the server certificate. \| \| \| options list / elements=string \| queried \| Enables options, including some industry-related workarounds. Sample: ['netscape-reuse-cipher-change-bug', 'dont-insert-empty-fragments'] \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: serverssl \| \| \| peer\_cert\_mode string \| queried \| Specifies the peer certificate mode. Sample: ignore \| \| \| proxy\_ssl boolean \| queried \| Allows further modification of application traffic within an SSL tunnel while still allowing the server to perform necessary authorization, authentication, auditing steps. Sample: True \| \| \| proxy\_ssl\_passthrough boolean \| queried \| Allows Proxy SSL to passthrough the traffic when ciphersuite negotiated between the client and server is not supported. Sample: True \| \| \| renegotiate\_period string \| queried \| Number of seconds from the initial connect time after which the system renegotiates an SSL session. Sample: indefinite \| \| \| renegotiate\_size string \| queried \| Specifies a throughput size of SSL renegotiation, in megabytes. Sample: indefinite \| \| \| renegotiation boolean \| queried \| Whether renegotiations are enabled. Sample: True \| \| \| retain\_certificate boolean \| queried \| APM module requires storing certificates in the SSL session. When `no`, a certificate will not be stored in the SSL session. \| \| \| secure\_renegotiation string \| queried \| Specifies the secure renegotiation mode. Sample: require \| \| \| server\_name string \| queried \| Server name to be included in the SNI (server name indication) extension during SSL handshake in ClientHello. \| \| \| session\_mirroring boolean \| queried \| Enables or disables the mirroring of sessions to the high availability peer. Sample: True \| \| \| session\_ticket boolean \| queried \| Enables or disables session-ticket. \| \| \| sni\_default boolean \| queried \| When `yes`, this profile is the default SSL profile when the server name in a client connection does not match any configured server names, or a client connection does not specify any server name at all. Sample: True \| \| \| sni\_require boolean \| queried \| When `yes`, connections to a server that do not support SNI extension will be rejected. \| \| \| ssl\_c3d boolean \| queried \| Enables or disables SSL Client certificate constrained delegation. Sample: True \| \| \| ssl\_forward\_proxy\_bypass boolean \| queried \| Enables or disables the ssl-forward-proxy-bypass feature. Sample: True \| \| \| ssl\_forward\_proxy\_enabled boolean \| queried \| Enables or disables the ssl-forward-proxy feature. \| \| \| ssl\_sign\_hash string \| queried \| Specifies the SSL sign hash algorithm which is used to sign and verify SSL Server Key Exchange and Certificate Verify messages for the specified SSL profiles. Sample: sha1 \| \| \| strict\_resume boolean \| queried \| Enables or disables the resumption of SSL sessions after an unclean shutdown. \| \| \| unclean\_shutdown boolean \| queried \| Specifies, when `yes`, that the SSL profile performs unclean shutdowns of all SSL connections. This means underlying TCP connections are closed without exchanging the required SSL shutdown alerts. Sample: True \| \| \| untrusted\_cert\_response\_control string \| queried \| Specifies the BIG-IP action when the server certificate has an untrusted CA. Sample: drop \| \| software\_hotfixes complex \| When `software-hotfixes` is specified in `gather_subset`. \| List of software hotfixes. Sample: hash/dictionary of values \| \| \| build string \| queried \| Build number of the image. This is usually a sub-string of the `name`. Sample: 3.0.1679 \| \| \| checksum string \| queried \| MD5 checksum of the image. Note that this is the checksum stored inside the ISO. It is not the actual checksum of the ISO. Sample: df1ec715d2089d0fa54c0c4284656a98 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: Hotfix-BIGIP-13.0.0.3.0.1679-HF3.iso \| \| \| id string \| queried \| ID component of the image. This is usually a sub-string of the `name`. Sample: HF3 \| \| \| name string \| queried \| Name of the image. Sample: Hotfix-BIGIP-13.0.0.3.0.1679-HF3.iso \| \| \| product string \| queried \| Product contained in the ISO. Sample: BIG-IP \| \| \| title string \| queried \| Human friendly name of the image. Sample: Hotfix Version 3.0.1679 \| \| \| verified boolean \| queried \| Specifies whether the system has verified this image. Sample: True \| \| \| version string \| queried \| Version of software contained in the image. This is a sub-string of the `name`. Sample: 13.0.0 \| \| software\_images complex \| When `software-images` is specified in `gather_subset`. \| List of software images. Sample: hash/dictionary of values \| \| \| build string \| queried \| Build number of the image. This is usually a sub-string of the `name`. Sample: 0.0.1 \| \| \| build\_date string \| queried \| Date of the build. Sample: 2018-05-05T15:26:30 \| \| \| checksum string \| queried \| MD5 checksum of the image. Note that this is the checksum stored inside the ISO. It is not the actual checksum of the ISO. Sample: df1ec715d2089d0fa54c0c4284656a98 \| \| \| file\_size integer \| queried \| Size of the image, in megabytes. Sample: 1938 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: BIGIP-13.1.0.7-0.0.1.iso \| \| \| last\_modified string \| queried \| Last modified date of the ISO. Sample: 2018-05-05T15:26:30 \| \| \| name string \| queried \| Name of the image. Sample: BIGIP-13.1.0.7-0.0.1.iso \| \| \| product string \| queried \| Product contained in the ISO. Sample: BIG-IP \| \| \| verified boolean \| queried \| Whether or not the system has verified this image. Sample: True \| \| \| version string \| queried \| Version of software contained in the image. This is a sub-string of the `name`. Sample: 13.1.0.7 \| \| software\_volumes complex \| When `software-volumes` is specified in `gather_subset`. \| List of software volumes. Sample: hash/dictionary of values \| \| \| active boolean \| queried \| Whether the volume is currently active or not. An active volume contains the currently running version of software. Sample: True \| \| \| base\_build string \| queried \| Base build version of the software installed in the volume. When a hotfix is installed, this refers to the base version of software that the hotfix requires. Sample: 0.0.6 \| \| \| build string \| queried \| Build version of the software installed in the volume. Sample: 0.0.6 \| \| \| default\_boot\_location boolean \| queried \| Whether this volume is the default boot location or not. Sample: True \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: HD1.1 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. This usually matches the `full_name`. Sample: HD1.1 \| \| \| product string \| queried \| The F5 product installed in this slot. This should always be BIG-IP. Sample: BIG-IP \| \| \| status string \| queried \| Status of the software installed, or being installed, in the volume. When `complete`, indicates the software has completed installing. Sample: complete \| \| \| version string \| queried \| Version of software installed in the volume, excluding the `build` number. Sample: 13.1.0.4 \| \| ssl\_certs complex \| When `ssl-certs` is specified in `gather_subset`. \| SSL certificate related information. Sample: hash/dictionary of values \| \| \| create\_time string \| queried \| Specifies the time the file-object was created. Sample: 2018-05-15T21:11:15Z \| \| \| expiration\_date string \| queried \| Specifies a string representation of the expiration date of the certificate. Sample: Aug 13 21:21:29 2031 GMT \| \| \| expiration\_timestamp integer \| queried \| Specifies the date this certificate expires. Stored as a POSIX time. Sample: 1944422489 \| \| \| fingerprint string \| queried \| Displays the SHA-256 fingerprint of the certificate. Sample: SHA256/88:A3:05:...:59:01:EA:5D:B0 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/cert1 \| \| \| is\_bundle boolean \| queried \| Specifies whether the certificate file is a bundle (that is, whether it contains more than one certificate). \| \| \| issuer string \| queried \| Specifies X509 information of the certificate's issuer. Sample: [email protected],...CN=support.f5.com, \| \| \| key\_size integer \| queried \| Specifies the size (in bytes) of the file associated with this file object. Sample: 2048 \| \| \| key\_type string \| queried \| Specifies the type of cryptographic key associated with this certificate. Sample: rsa-private \| \| \| last\_update\_time string \| queried \| Specifies the last time the file-object was updated/modified. Sample: 2018-05-15T21:11:15Z \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: cert1 \| \| \| serial\_no string \| queried \| Specifies certificate's serial number Sample: 1234567890 \| \| \| sha1\_checksum string \| queried \| SHA1 checksum of the certificate. Sample: 1306e84e1e6a2da53816cefe1f684b80d6be1e3e \| \| \| subject string \| queried \| Specifies X509 information of the certificate's subject. Sample: [email protected],CN=... \| \| \| subject\_alternative\_name string \| queried \| Displays the Subject Alternative Name for the certificate. The X509v3 Subject Alternative Name is embedded in the certificate for X509 extension purposes. Sample: DNS:www.example.com, DNS:www.example.internal.net \| \| \| system\_path string \| queried \| Path on the BIG-IP where the cert can be found. Sample: /config/ssl/ssl.crt/f5-irule.crt \| \| ssl\_keys complex \| When `ssl-keys` is specified in `gather_subset`. \| SSL certificate related information. Sample: hash/dictionary of values \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/key1 \| \| \| key\_size integer \| queried \| Specifies the size of the cryptographic key associated with this file object, in bits. Sample: 2048 \| \| \| key\_type string \| queried \| Specifies the cryptographic type of the key. That is, which algorithm this key is compatible with. Sample: rsa-private \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: key1 \| \| \| security\_type string \| queried \| Specifies the type of security used to handle or store the key. Sample: normal \| \| \| sha1\_checksum string \| queried \| The SHA1 checksum of the key. Sample: 1fcf7de3dd8e834d613099d8e10b2060cd9ecc9f \| \| \| system\_path string \| queried \| The path on the filesystem where the key is stored. Sample: /config/ssl/ssl.key/default.key \| \| sync\_status complex \| When `sync-status` is specified in `gather_subset`. \| Configuration Synchronization Status across all Device Groups. Note that the sync-status works across all device groups - a specific device group cannot be queried for its sync-status. In general the device-group with the 'worst' sync-status will be shown. Sample: hash/dictionary of values \| \| \| color string \| queried \| Sync status color. Eg. red, blue, green, yellow Sample: red \| \| \| details list / elements=string \| queried \| A list of all details provided for the current sync-status of the device Sample: [{'Optional action': 'Add a device to the trust domain'}] \| \| \| mode string \| queried \| Device operation mode (high-availability, standalone) Sample: ['high-availability', 'standalone'] \| \| \| recommended\_action string \| queried \| The next recommended action to take on the current sync-status. This field might be empty. Sample: Synchronize bigip-a.example.com to group some-device-group \| \| \| status string \| queried \| Synchronization Status Sample: ['Changes Pending', 'In Sync', 'Standalone', 'Disconnected'] \| \| \| summary string \| queried \| The configuration synchronization status summary Sample: ['The device group is awaiting the initial config sync', 'There is a possible change conflict between ...'] \| \| system\_db complex \| When `system-db` is specified in `gather_subset`. \| System DB related information. Sample: hash/dictionary of values \| \| \| default string \| queried \| Default value of the key. Sample: www.f5.com \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: vendor.wwwurl \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: vendor.wwwurl \| \| \| scf\_config string \| queried \| Whether the database key would be found in an SCF config or not. \| \| \| value string \| queried \| The value of the key. Sample: www.f5.com \| \| \| value\_range string \| queried \| The accepted range of values for the key. Sample: string \| \| system\_info complex \| When `traffic-groups` is specified in `gather_subset`. \| Traffic group related information. Sample: hash/dictionary of values \| \| \| base\_mac\_address string \| queried \| Media Access Control address (MAC address) of the device. Sample: fa:16:3e:c3:42:6f \| \| \| chassis\_serial string \| queried \| Serial of the chassis. Sample: 11111111-2222-3333-444444444444 \| \| \| hardware\_information complex \| queried \| Information related to the hardware (drives and CPUs) of the system. \| \| \| \| model string \| queried \| The model of the hardware. Sample: Virtual Disk \| \| \| \| name string \| queried \| The name of the hardware. Sample: HD1 \| \| \| \| type string \| queried \| The type of hardware. Sample: physical-disk \| \| \| \| versions complex \| queried \| Hardware specific properties. \| \| \| \| \| name string \| queried \| Name of the property. Sample: Size \| \| \| \| \| version string \| queried \| Value of the property. Sample: 154.00G \| \| \| host\_board\_part\_revision string \| queried \| Revision of the host board. \| \| \| host\_board\_serial string \| queried \| Serial of the host board. \| \| \| marketing\_name string \| queried \| Marketing name of the device platform. Sample: BIG-IP Virtual Edition \| \| \| package\_edition string \| queried \| Displays the software edition. Sample: Point Release 7 \| \| \| package\_version string \| queried \| A string combining the `product_build` and `product_build_date`. Sample: Build 0.0.1 - Tue May 15 15:26:30 PDT 2018 \| \| \| platform string \| queried \| Platform identifier. Sample: Z100 \| \| \| product\_build string \| queried \| Build version of the release version. Sample: 0.0.1 \| \| \| product\_build\_date string \| queried \| Human readable build date. Sample: Tue May 15 15:26:30 PDT 2018 \| \| \| product\_built integer \| queried \| UNIX timestamp of when the product was built. Sample: 180515152630 \| \| \| product\_changelist integer \| queried \| Changelist the product branches from. Sample: 2557198 \| \| \| product\_code string \| queried \| Code identifying the product. Sample: BIG-IP \| \| \| product\_jobid integer \| queried \| ID of the job that built the product version. Sample: 1012030 \| \| \| product\_version string \| queried \| Major product version of the running software. Sample: 13.1.0.7 \| \| \| switch\_board\_part\_revision string \| queried \| Switch board revision. \| \| \| switch\_board\_serial string \| queried \| Serial of the switch board. \| \| \| time complex \| queried \| Mapping of the current time information to specific time-named keys. \| \| \| \| day integer \| queried \| The current day of the month, in numeric form. Sample: 7 \| \| \| \| hour integer \| queried \| The current hour of the day in 24-hour format. Sample: 18 \| \| \| \| minute integer \| queried \| The current minute of the hour. Sample: 16 \| \| \| \| month integer \| queried \| The current month, in numeric form. Sample: 6 \| \| \| \| second integer \| queried \| The current second of the minute. Sample: 51 \| \| \| \| year integer \| queried \| The current year in 4-digit format. Sample: 2018 \| \| \| uptime integer \| queried \| Time since the system booted, in seconds. Sample: 603202 \| \| tcp\_half\_open\_monitors complex \| When `tcp-half-open-monitors` is specified in `gather_subset`. \| TCP Half-open monitor related information. Sample: hash/dictionary of values \| \| \| description string \| queried \| Description of the resource. Sample: My monitor \| \| \| destination string \| queried \| Specifies the IP address and service port of the resource that is the destination of this monitor. Sample: \:\ \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/tcp \| \| \| interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. Sample: 5 \| \| \| manual\_resume boolean \| queried \| Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: tcp \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: tcp \| \| \| time\_until\_up integer \| queried \| Specifies the amount of time, in seconds, after the first successful response before a node is marked up. \| \| \| timeout integer \| queried \| Specifies the number of seconds the target has in which to respond to the monitor request. Sample: 16 \| \| \| transparent boolean \| queried \| Specifies whether the monitor operates in transparent mode. \| \| \| up\_interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. \| \| tcp\_monitors complex \| When `tcp-monitors` is specified in `gather_subset`. \| TCP monitor related information. Sample: hash/dictionary of values \| \| \| adaptive boolean \| queried \| Whether adaptive response time monitoring is enabled for this monitor. \| \| \| adaptive\_divergence\_type string \| queried \| Specifies whether the adaptive-divergence-value is `relative` or `absolute`. Sample: relative \| \| \| adaptive\_divergence\_value integer \| queried \| Specifies how far from mean latency each monitor probe is allowed to be. Sample: 25 \| \| \| adaptive\_limit integer \| queried \| Specifies the hard limit, in milliseconds, which the probe is not allowed to exceed, regardless of the divergence value. Sample: 200 \| \| \| adaptive\_sampling\_timespan integer \| queried \| Specifies the size of the sliding window, in seconds, which records probe history. Sample: 300 \| \| \| description string \| queried \| Description of the resource. Sample: My monitor \| \| \| destination string \| queried \| Specifies the IP address and service port of the resource that is the destination of this monitor. Sample: \:\ \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/tcp \| \| \| interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. Sample: 5 \| \| \| ip\_dscp integer \| queried \| Specifies the differentiated services code point (DSCP). \| \| \| manual\_resume boolean \| queried \| Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: tcp \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: tcp \| \| \| reverse boolean \| queried \| Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful check marks the monitored object down instead of up. \| \| \| time\_until\_up integer \| queried \| Specifies the amount of time, in seconds, after the first successful response before a node is marked up. \| \| \| timeout integer \| queried \| Specifies the number of seconds the target has in which to respond to the monitor request. Sample: 16 \| \| \| transparent boolean \| queried \| Specifies whether the monitor operates in transparent mode. \| \| \| up\_interval integer \| queried \| Specifies, in seconds, the frequency at which the system issues the monitor check when the resource is up. \| \| tcp\_profiles complex \| When `tcp-profiles` is specified in `gather_subset`. \| TCP profile related information. Sample: hash/dictionary of values \| \| \| abc boolean \| queried \| Appropriate Byte Counting (RFC 3465) When `yes`, increases the congestion window by basing the amount to increase on the number of previously unacknowledged bytes that each ACK covers. Sample: True \| \| \| ack\_on\_push boolean \| queried \| When `yes`, specifies significantly improved performance to Microsoft Windows and MacOS peers who are writing out on a very small send buffer. \| \| \| auto\_proxy\_buffer boolean \| queried \| When `yes`, specifies the system uses the network measurements to set the optimal proxy buffer size. Sample: True \| \| \| auto\_receive\_window boolean \| queried \| When `yes`, specifies the system uses the network measurements to set the optimal receive window size. \| \| \| auto\_send\_buffer boolean \| queried \| When `yes`, specifies the system uses the network measurements to set the optimal send buffer size. Sample: True \| \| \| close\_wait string \| queried \| Specifies the length of time a TCP connection remains in the LAST-ACK state before quitting. In addition to a numeric value, the value of this fact may also be one of `immediate` or `indefinite`. When `immediate`, specifies the TCP connection closes immediately after entering the LAST-ACK state. When `indefinite`, specifies that TCP connections in the LAST-ACK state do not close until they meet the maximum retransmissions timeout. Sample: indefinite \| \| \| congestion\_control string \| queried \| Specifies the algorithm to use to share network resources among competing users to reduce congestion. Return values may include, `high-speed`, `cdg`, `chd`, `none`, `cubic`, `illinois`, `new-reno`, `reno`, `scalable`, `vegas`, `westwood`, and `woodside`. Sample: high-speed \| \| \| congestion\_metrics\_cache boolean \| queried \| When `yes`, specifies the system uses a cache for storing congestion metrics. Subsequently, because these metrics are already known and cached, the initial slow-start ramp for previously-encountered peers improves. Sample: True \| \| \| congestion\_metrics\_cache\_timeout integer \| queried \| Specifies the number of seconds for which entries in the congestion metrics cache are valid. \| \| \| deferred\_accept boolean \| queried \| When `yes`, specifies the system defers allocation of the connection chain context until the system has received the payload from the client. Enabling this setting is useful in dealing with 3-way handshake denial-of-service attacks. Sample: True \| \| \| delay\_window\_control boolean \| queried \| Specifies the system uses an estimate of queuing delay as a measure of congestion to control, in addition to the normal loss-based control, the amount of data sent. Sample: True \| \| \| delayed\_acks boolean \| queried \| When checked (enabled), specifies the system can send fewer than one ACK (acknowledgment) segment per data segment received. Sample: True \| \| \| description string \| queried \| Description of the resource. Sample: My profile \| \| \| dont\_fragment\_flag string \| queried \| Specifies the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet. Sample: pmtu \| \| \| dsack boolean \| queried \| D-SACK (RFC 2883) When `yes`, specifies the use of the selective ACK (SACK) option to acknowledge duplicate segments. Sample: True \| \| \| early\_retransmit boolean \| queried \| When `yes`, specifies the system uses early retransmit (as specified in RFC 5827) to reduce the recovery time for connections that are receive- buffer or user-data limited. Sample: True \| \| \| enhanced\_loss\_recovery boolean \| queried \| Specifies whether the system uses enhanced loss recovery to recover from random packet losses more effectively. Sample: True \| \| \| explicit\_congestion\_notification boolean \| queried \| When `yes`, specifies the system uses the TCP flags CWR (congestion window reduction) and ECE (ECN-Echo) to notify its peer of congestion and congestion counter-measures. Sample: True \| \| \| fast\_open boolean \| queried \| When `yes`, specifies, the system supports TCP Fast Open, which reduces latency by allowing a client to include the first packet of data with the SYN Sample: True \| \| \| fast\_open\_cookie\_expiration integer \| queried \| Specifies the number of seconds that a Fast Open Cookie delivered to a client is valid for SYN packets from that client. Sample: 1000 \| \| \| fin\_wait\_1 string \| queried \| Specifies the length of time that a TCP connection is in the FIN-WAIT-1 or CLOSING state before quitting. Sample: indefinite \| \| \| fin\_wait\_2 string \| queried \| Specifies the length of time a TCP connection is in the FIN-WAIT-2 state before quitting. Sample: 100 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: tcp \| \| \| idle\_timeout string \| queried \| Specifies the length of time a connection is idle (has no traffic) before the connection is eligible for deletion. Sample: 300 \| \| \| initial\_congestion\_window\_size integer \| queried \| Specifies the initial congestion window size for connections to this destination. Sample: 3 \| \| \| initial\_receive\_window\_size integer \| queried \| Specifies the initial receive window size for connections to this destination. Sample: 5 \| \| \| ip\_tos string \| queried \| Specifies the L3 Type of Service (ToS) level the system inserts in TCP packets destined for clients. Sample: mimic \| \| \| keep\_alive\_interval string \| queried \| Specifies how frequently the system sends data over an idle TCP connection, to determine whether the connection is still valid. Sample: 50 \| \| \| limited\_transmit\_recovery boolean \| queried \| When `yes`, specifies the system uses limited transmit recovery revisions for fast retransmits (as specified in RFC 3042) to reduce the recovery time for connections on a lossy network. Sample: True \| \| \| link\_qos string \| queried \| Specifies the L2 Quality of Service (QoS) level the system inserts in TCP packets destined for clients. Sample: 200 \| \| \| max\_segment\_retrans integer \| queried \| Specifies the maximum number of times that the system resends data segments. Sample: 8 \| \| \| max\_segment\_size integer \| queried \| Specifies the largest amount of data the system can receive in a single TCP segment, not including the TCP and IP headers. Sample: 1460 \| \| \| max\_syn\_retrans integer \| queried \| Specifies the maximum number of times the system resends a SYN packet when it does not receive a corresponding SYN-ACK. Sample: 3 \| \| \| md5\_signature boolean \| queried \| When `yes`, specifies to use RFC2385 TCP-MD5 signatures to protect TCP traffic against intermediate tampering. Sample: True \| \| \| minimum\_rto integer \| queried \| Specifies the minimum length of time the system waits for acknowledgements of data sent before resending the data. Sample: 1000 \| \| \| mptcp\_checksum boolean \| queried \| When `yes`, specifies the system calculates the checksum for MPTCP connections. \| \| \| mptcp\_checksum\_verify boolean \| queried \| When `yes`, specifies the system verifies the checksum for MPTCP connections. \| \| \| mptcp\_fallback string \| queried \| Specifies an action on fallback, that is, when MPTCP transitions to regular TCP, because something prevents MPTCP from working correctly. Sample: reset \| \| \| mptcp\_fast\_join boolean \| queried \| When `yes`, specifies a FAST join, allowing data to be sent on the MP\_JOIN\_SYN, which can allow a server response to occur in parallel with the JOIN. \| \| \| mptcp\_idle\_timeout integer \| queried \| Specifies the number of seconds that an MPTCP connection is idle before the connection is eligible for deletion. Sample: 300 \| \| \| mptcp\_join\_max integer \| queried \| Specifies the highest number of MPTCP connections that can join to a given connection. Sample: 5 \| \| \| mptcp\_make\_after\_break boolean \| queried \| Specifies make-after-break functionality is supported, allowing for long-lived MPTCP sessions. \| \| \| mptcp\_no\_join\_dss\_ack boolean \| queried \| When checked (enabled), specifies no DSS option is sent on the JOIN ACK. \| \| \| mptcp\_retransmit\_min integer \| queried \| Specifies the minimum value (in msec) of the retransmission timer for these MPTCP flows. Sample: 1000 \| \| \| mptcp\_rto\_max integer \| queried \| Specifies the number of RTOs (retransmission timeouts) before declaring the subflow dead. Sample: 5 \| \| \| mptcp\_subflow\_max integer \| queried \| Specifies the maximum number of MPTCP subflows for a single flow. Sample: 6 \| \| \| mptcp\_timeout integer \| queried \| Specifies, in seconds, the timeout value to discard long-lived sessions that do not have an active flow. Sample: 3600 \| \| \| multipath\_tcp boolean \| queried \| When `yes`, specifies the system accepts Multipath TCP (MPTCP) connections, which allow multiple client-side flows to connect to a single server-side flow. Sample: True \| \| \| nagle\_algorithm boolean \| queried \| Specifies whether the system applies Nagle's algorithm to reduce the number of short segments on the network. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: /Common/tcp \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: tcp \| \| \| pkt\_loss\_ignore\_burst integer \| queried \| Specifies the probability of performing congestion control when multiple packets are lost, even if the Packet Loss Ignore Rate was not exceeded. \| \| \| pkt\_loss\_ignore\_rate integer \| queried \| Specifies the threshold of packets lost per million at which the system performs congestion control. \| \| \| proxy\_buffer\_high integer \| queried \| Specifies the proxy buffer level, in bytes, at which the receive window is closed. Sample: 49152 \| \| \| proxy\_buffer\_low integer \| queried \| Specifies the proxy buffer level, in bytes, at which the receive window is opened. Sample: 32768 \| \| \| proxy\_max\_segment boolean \| queried \| When `yes`, specifies the system attempts to advertise the same maximum segment size (MSS) to the server-side connection as that of the client-side connection. Sample: True \| \| \| proxy\_options boolean \| queried \| When `yes`, specifies the system advertises an option (such as time stamps) to the server only when the option is negotiated with the client. \| \| \| push\_flag string \| queried \| Specifies how the BIG-IP system receives ACKs. Sample: default \| \| \| rate\_pace boolean \| queried \| When `yes`, specifies the system paces the egress packets to avoid dropping packets, allowing for optimum goodput. Sample: True \| \| \| rate\_pace\_max\_rate integer \| queried \| Specifies the maximum rate in bytes per second to which the system paces TCP data transmission. \| \| \| receive\_window integer \| queried \| Specifies the maximum advertised RECEIVE window size. Sample: 65535 \| \| \| reset\_on\_timeout boolean \| queried \| When `yes`, specifies the system sends a reset packet (RST) in addition to deleting the connection, when a connection exceeds the idle timeout value. Sample: True \| \| \| retransmit\_threshold integer \| queried \| Specifies the number of duplicate ACKs (retransmit threshold) to start fast recovery. Sample: 3 \| \| \| selective\_acks boolean \| queried \| When `yes`, specifies the system processes data using selective ACKs (SACKs) whenever possible, to improve system performance. Sample: True \| \| \| selective\_nack boolean \| queried \| When `yes`, specifies the system processes data using a selective negative acknowledgment (SNACK) whenever possible, to improve system performance. Sample: True \| \| \| send\_buffer integer \| queried \| Specifies the SEND window size. Sample: 65535 \| \| \| slow\_start boolean \| queried \| When `yes`, specifies the system uses Slow-Start Congestion Avoidance as described in RFC3390 in order to ramp up traffic without causing excessive congestion on the link. Sample: True \| \| \| syn\_cookie\_enable boolean \| queried \| Specifies the default (if no DoS profile is associated) number of embryonic connections that are allowed on any virtual server, before SYN Cookie challenges are enabled for that virtual server. Sample: True \| \| \| syn\_cookie\_white\_list boolean \| queried \| Specifies whether or not to use a SYN Cookie WhiteList when doing software SYN Cookies. \| \| \| syn\_retrans\_to\_base integer \| queried \| Specifies the initial RTO (Retransmission TimeOut) base multiplier for SYN retransmissions. Sample: 3000 \| \| \| tail\_loss\_probe boolean \| queried \| When `yes`, specifies the system uses Tail Loss Probe to reduce the number of retransmission timeouts. Sample: True \| \| \| time\_to\_live string \| queried \| Specifies the outgoing TCP packet's IP Header TTL mode. Sample: proxy \| \| \| time\_to\_live\_v4 integer \| queried \| Specifies the outgoing packet's IP Header TTL value for IPv4 traffic. Sample: 255 \| \| \| time\_to\_live\_v6 integer \| queried \| Specifies the outgoing packet's IP Header TTL value for IPv6 traffic. Sample: 64 \| \| \| time\_wait string \| queried \| Specifies the length of time that a TCP connection remains in the TIME-WAIT state before entering the CLOSED state. Sample: 2000 \| \| \| time\_wait\_recycle boolean \| queried \| When `yes`, specifies that connections in a TIME-WAIT state are reused when the system receives a SYN packet, indicating a request for a new connection. Sample: True \| \| \| timestamps boolean \| queried \| When `yes`, specifies the system uses the timestamps extension for TCP (as specified in RFC 1323) to enhance high-speed network performance. Sample: True \| \| \| verified\_accept boolean \| queried \| When `yes`, specifies the system can actually communicate with the server before establishing a client connection. Sample: True \| \| \| zero\_window\_timeout string \| queried \| Specifies the timeout in milliseconds for terminating a connection with an effective zero length TCP transmit window. Sample: 2000 \| \| traffic\_groups complex \| When `traffic-groups` is specified in `gather_subset`. \| Traffic group related information. Sample: hash/dictionary of values \| \| \| auto\_failback\_enabled boolean \| queried \| Specifies whether the traffic group fails back to the default device. Sample: True \| \| \| auto\_failback\_time integer \| queried \| Specifies the time required to fail back. Sample: 60 \| \| \| description string \| queried \| Description of the traffic group. Sample: My traffic group \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/tg1 \| \| \| ha\_load\_factor integer \| queried \| Specifies a number for this traffic group that represents the load this traffic group presents to the system relative to other traffic groups. Sample: 1 \| \| \| ha\_order list / elements=string \| queried \| This list of devices specifies the order in which the devices will become active for the traffic group when a failure occurs. Sample: ['/Common/device1', '/Common/device2'] \| \| \| is\_floating boolean \| queried \| Indicates whether the traffic group can fail over to other devices in the device group. \| \| \| mac\_masquerade\_address string \| queried \| Specifies a MAC address for the traffic group. Sample: 00:98:76:54:32:10 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: tg1 \| \| trunks complex \| When `trunks` is specified in `gather_subset`. \| Trunk related information. Sample: hash/dictionary of values \| \| \| configured\_member\_count integer \| queried \| The number of configured members that are associated with the trunk. Sample: 1 \| \| \| description string \| queried \| Description of the Trunk. Sample: My trunk \| \| \| distribution\_hash string \| queried \| The basis for the hash that the system uses as the frame distribution algorithm. The system uses this hash to determine which interface to use for forwarding traffic. Sample: src-dst-ipport \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/trunk1 \| \| \| interfaces list / elements=string \| queried \| The list of interfaces that are part of the trunk. Sample: ['1.2', '1.3'] \| \| \| lacp\_enabled boolean \| queried \| Whether LACP is enabled or not. Sample: True \| \| \| lacp\_mode string \| queried \| The operation mode for LACP. Sample: passive \| \| \| lacp\_timeout integer \| queried \| The rate at which the system sends the LACP control packets. Sample: 10 \| \| \| link\_selection\_policy string \| queried \| The LACP policy the trunk uses to determine which member link can handle new traffic. Sample: maximum-bandwidth \| \| \| media\_speed integer \| queried \| Speed of the media attached to the trunk. Sample: 10000 \| \| \| media\_status boolean \| queried \| Whether the media that is part of the trunk is up or not. Sample: True \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: trunk1 \| \| \| operational\_member\_count integer \| queried \| Number of working members associated with the trunk. Sample: 1 \| \| \| stp\_enabled boolean \| queried \| Whether Spanning Tree Protocol (STP) is enabled or not. Sample: True \| \| udp\_profiles complex \| When `udp-profiles` is specified in `gather_subset`. \| UDP profile related information. Sample: hash/dictionary of values \| \| \| allow\_no\_payload boolean \| queried \| Allow the passage of datagrams that contain header information, but no essential data. Sample: True \| \| \| buffer\_max\_bytes integer \| queried \| Ingress buffer byte limit. Maximum allowed value is 16777215. Sample: 655350 \| \| \| buffer\_max\_packets integer \| queried \| Ingress buffer packet limit. Maximum allowed value is 255. \| \| \| datagram\_load\_balancing boolean \| queried \| Load balance UDP datagram by datagram Sample: True \| \| \| description string \| queried \| Description of the resource. Sample: My profile \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: udp \| \| \| idle\_timeout boolean \| queried \| Number of seconds that a connection is idle before the connection is eligible for deletion. In addition to a number, may be one of the values `indefinite` or `immediate`. Sample: 200 \| \| \| ip\_df\_mode string \| queried \| Describes the Don't Fragment (DF) bit setting in the outgoing UDP packet. May be one of `pmtu`, `preserve`, `set`, or `clear`. When `pmtu`, sets the outgoing UDP packet DF big based on the ip pmtu setting. When `preserve`, preserves the incoming UDP packet Don't Fragment bit. When `set`, sets the outgoing UDP packet DF bit. When `clear`, clears the outgoing UDP packet DF bit. Sample: pmtu \| \| \| ip\_tos\_to\_client string \| queried \| The Type of Service level the traffic management system assigns to UDP packets when sending them to clients. May be numeric, or the values `pass-through` or `mimic`. Sample: mimic \| \| \| ip\_ttl\_mode string \| queried \| The outgoing UDP packet's TTL mode. Valid modes are `proxy`, `preserve`, `decrement`, and `set`. When `proxy`, sets the IP TTL of IPv4 to the default value of 255 and IPv6 to the default value of 64. When `preserve`, sets the IP TTL to the original packet TTL value. When `decrement`, sets the IP TTL to the original packet TTL value minus 1. When `set`, sets the IP TTL with the specified values in `ip_ttl_v4` and `ip_ttl_v6` values in the same profile. Sample: proxy \| \| \| ip\_ttl\_v4 integer \| queried \| IPv4 TTL. Sample: 10 \| \| \| ip\_ttl\_v6 integer \| queried \| IPv6 TTL. Sample: 100 \| \| \| link\_qos\_to\_client string \| queried \| The Quality of Service level the system assigns to UDP packets when sending them to clients. May be either numberic or the value `pass-through`. Sample: pass-through \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: /Common/udp \| \| \| no\_checksum boolean \| queried \| Whether checksum processing is enabled or disabled. Note that if the datagram is IPv6, the system always performs checksum processing. Sample: True \| \| \| parent string \| queried \| Profile from which this profile inherits settings. Sample: udp \| \| \| proxy\_mss boolean \| queried \| When `yes`, specifies the system advertises the same mss to the server as was negotiated with the client. Sample: True \| \| users complex \| When `users` is specified in `gather_subset`. \| Details of the users on the system. \| \| \| description string \| queried \| Description of the resource. Sample: Admin user \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: admin \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: admin \| \| \| partition\_access complex \| queried \| Partition that user has access to, including user role. \| \| \| \| name string \| queried \| Name of partition. Sample: all-partitions \| \| \| \| role string \| queried \| Role allowed to user on partition. Sample: auditor \| \| \| shell string \| queried \| The shell assigned to the user account. Sample: tmsh \| \| vcmp\_guests complex \| When `vcmp-guests` is specified in `gather_subset`. \| vCMP related information. Sample: hash/dictionary of values \| \| \| allowed\_slots list / elements=string \| queried \| List of slots the guest is allowed to be assigned to. Sample: [0, 1, 3] \| \| \| assigned\_slots list / elements=string \| queried \| Slots the guest is assigned to. Sample: [0] \| \| \| boot\_priority integer \| queried \| Specifies the boot priority of the guest. A lower number means earlier to boot. Sample: 65535 \| \| \| cores\_per\_slot integer \| queried \| Number of cores the system allocates to the guest. Sample: 2 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: guest1 \| \| \| hostname string \| queried \| FQDN assigned to the guest. Sample: guest1.localdomain \| \| \| hotfix\_image string \| queried \| Hotfix image to install onto any of this guest's newly created virtual disks. Sample: Hotfix-BIGIP-12.1.3.4-0.0.2-hf1.iso \| \| \| initial\_image string \| queried \| Software image to install onto any of this guest's newly created virtual disks. Sample: BIGIP-12.1.3.4-0.0.2.iso \| \| \| mgmt\_address string \| queried \| Management IP address configuration for the guest. Sample: 2.3.2.3 \| \| \| mgmt\_network string \| queried \| Accessibility of this vCMP guest's management network. Sample: bridged \| \| \| mgmt\_route string \| queried \| Management gateway IP address for the guest. Sample: 2.2.2.1 \| \| \| min\_number\_of\_slots integer \| queried \| Specifies the minimum number of slots the guest must be assigned to. Sample: 2 \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: guest1 \| \| \| number\_of\_slots integer \| queried \| Specifies the number of slots the guest should be assigned to. This number is always greater than, or equal to, `min_number_of_slots`. Sample: 2 \| \| \| ssl\_mode string \| queried \| The SSL hardware allocation mode for the guest. Sample: shared \| \| \| state string \| queried \| Specifies the state of the guest. May be one of `configured`, `provisioned`, or `deployed`. Each state implies the actions of all states before it. Sample: provisioned \| \| \| virtual\_disk string \| queried \| The filename of the virtual disk to use for this guest. Sample: guest1.img \| \| \| vlans list / elements=string \| queried \| List of VLANs on which the guest is either enabled or disabled. Sample: ['/Common/vlan1', '/Common/vlan2'] \| \| virtual\_addresses complex \| When `virtual-addresses` is specified in `gather_subset`. \| Virtual address related information. Sample: hash/dictionary of values \| \| \| address string \| queried \| The virtual IP address. Sample: 2.3.4.5 \| \| \| arp\_enabled boolean \| queried \| Whether or not ARP is enabled for the specified virtual address. Sample: True \| \| \| auto\_delete\_enabled boolean \| queried \| Indicates if the virtual address will be deleted automatically on deletion of the last associated virtual server or not. \| \| \| connection\_limit integer \| queried \| Concurrent connection limit for one or more virtual servers. \| \| \| description string \| queried \| The description of the virtual address. Sample: My virtual address \| \| \| enabled boolean \| queried \| Whether the virtual address is enabled or not. Sample: True \| \| \| floating boolean \| queried \| Property derived from the traffic group. A floating virtual address is a virtual address for a VLAN that serves as a shared address by all devices of a BIG-IP traffic-group. Sample: True \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/2.3.4.5 \| \| \| icmp\_echo boolean \| queried \| Whether the virtual address should reply to ICMP echo requests. Sample: True \| \| \| inherited\_traffic\_group boolean \| queried \| Indicates if the traffic group is inherited from the parent folder. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: 2.3.4.5 \| \| \| netmask string \| queried \| Netmask of the virtual address. Sample: 255.255.255.255 \| \| \| route\_advertisement boolean \| queried \| Specifies the route advertisement setting for the virtual address. \| \| \| spanning boolean \| queried \| Whether or not spanning is enabled for the specified virtual address. \| \| \| traffic\_group string \| queried \| Traffic group on which the virtual address is active. Sample: /Common/traffic-group-1 \| \| virtual\_servers complex \| When `virtual-addresses` is specified in `gather_subset`. \| Virtual address related information. Sample: hash/dictionary of values \| \| \| authentication\_profile list / elements=string \| queried \| Specifies a list of authentication profile names, separated by spaces, that the virtual server uses to manage authentication. Sample: ['/Common/ssl\_drldp'] \| \| \| auto\_lasthop string \| queried \| When enabled, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. Sample: default \| \| \| availability\_status string \| queried \| The availability of the virtual server. Sample: offline \| \| \| bw\_controller\_policy string \| queried \| The bandwidth controller for the system to use to enforce a throughput policy for incoming network traffic. Sample: /Common/bw1 \| \| \| client\_side\_bits\_in integer \| queried \| Number of client-side ingress bits. Sample: 1000 \| \| \| client\_side\_bits\_out integer \| queried \| Number of client-side egress bits. Sample: 200 \| \| \| client\_side\_current\_connections integer \| queried \| Number of current connections client-side. Sample: 300 \| \| \| client\_side\_evicted\_connections integer \| queried \| Number of evicted connections client-side. Sample: 100 \| \| \| client\_side\_max\_connections integer \| queried \| Maximum number of connections client-side. Sample: 40 \| \| \| client\_side\_pkts\_in integer \| queried \| Number of client-side ingress packets. Sample: 1098384 \| \| \| client\_side\_pkts\_out integer \| queried \| Number of client-side egress packets. Sample: 3484734 \| \| \| client\_side\_slow\_killed integer \| queried \| Number of slow connections killed, client-side. Sample: 234 \| \| \| client\_side\_total\_connections integer \| queried \| Total number of connections. Sample: 24 \| \| \| cmp\_enabled boolean \| queried \| Whether or not clustered multi-processor (CMP) acceleration is enabled. Sample: True \| \| \| cmp\_mode string \| queried \| The clustered-multiprocessing mode. Sample: all-cpus \| \| \| connection\_limit integer \| queried \| Maximum number of concurrent connections you want to allow for the virtual server. Sample: 100 \| \| \| connection\_mirror\_enabled boolean \| queried \| Whether or not connection mirroring is enabled. Sample: True \| \| \| cpu\_usage\_ratio\_last\_1\_min integer \| queried \| CPU Usage Ratio (%) Last 1 Minute. \| \| \| cpu\_usage\_ratio\_last\_5\_min integer \| queried \| CPU Usage Ratio (%) Last 5 Minutes. \| \| \| cpu\_usage\_ratio\_last\_5\_sec integer \| queried \| CPU Usage Ratio (%) Last 5 Seconds. \| \| \| current\_syn\_cache integer \| queried \| Current SYN Cache. \| \| \| default\_pool string \| queried \| Pool name you want the virtual server to use as the default pool. Sample: /Common/pool1 \| \| \| description string \| queried \| The description of the virtual server. Sample: My virtual \| \| \| destination string \| queried \| Name of the virtual address and service on which the virtual server listens for connections. Sample: /Common/2.2.3.3%1:76 \| \| \| destination\_address string \| queried \| Address portion of the `destination`. Sample: 2.3.3.2 \| \| \| destination\_port integer \| queried \| Port potion of the `destination`. Sample: 80 \| \| \| enabled boolean \| queried \| Whether or not the virtual is enabled. Sample: True \| \| \| ephemeral\_bits\_in integer \| queried \| Number of ephemeral ingress bits. Sample: 1000 \| \| \| ephemeral\_bits\_out integer \| queried \| Number of ephemeral egress bits. Sample: 200 \| \| \| ephemeral\_current\_connections integer \| queried \| Number of ephemeral current connections. Sample: 300 \| \| \| ephemeral\_evicted\_connections integer \| queried \| Number of ephemeral evicted connections. Sample: 100 \| \| \| ephemeral\_max\_connections integer \| queried \| Maximum number of ephemeral connections. Sample: 40 \| \| \| ephemeral\_pkts\_in integer \| queried \| Number of ephemeral ingress packets. Sample: 1098384 \| \| \| ephemeral\_pkts\_out integer \| queried \| Number of ephemeral egress packets. Sample: 3484734 \| \| \| ephemeral\_slow\_killed integer \| queried \| Number of ephemeral slow connections killed. Sample: 234 \| \| \| ephemeral\_total\_connections integer \| queried \| Total number of ephemeral connections. Sample: 24 \| \| \| fallback\_persistence\_profile string \| queried \| Fallback persistence profile for the virtual server to use when the default persistence profile is not available. Sample: /Common/fallback1 \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/2.3.4.5 \| \| \| gtm\_score integer \| queried \| Specifies a score that is associated with the virtual server. \| \| \| hardware\_syn\_cookie\_instances integer \| queried \| Hardware SYN Cookie Instances. \| \| \| ip\_intelligence\_policy string \| queried \| IP Intelligence policy assigned to the virtual. Sample: /Common/ip1 \| \| \| irules list / elements=string \| queried \| List of iRules that customize the virtual server to direct and manage traffic. Sample: ['/Common/rule1', "/Common/rule2'"] \| \| \| last\_hop\_pool string \| queried \| Name of the last hop pool you want the virtual server to use to direct reply traffic to the last hop router. Sample: /Common/pool1 \| \| \| max\_conn\_duration integer \| queried \| Max Conn Duration/msec. \| \| \| mean\_conn\_duration integer \| queried \| Mean Conn Duration/msec. \| \| \| min\_conn\_duration integer \| queried \| Min Conn Duration/msec. \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: 2.3.4.5 \| \| \| nat64\_enabled boolean \| queried \| Whether or not NAT64 is enabled. Sample: True \| \| \| persistence\_profile string \| queried \| The persistence profile you want the system to use as the default for this virtual server. Sample: /Common/persist1 \| \| \| policies list / elements=string \| queried \| List of LTM policies attached to the virtual server. Sample: ['/Common/policy1', "/Common/policy2'"] \| \| \| profiles complex \| success \| List of the profiles attached to the virtual. \| \| \| \| context string \| queried \| Which side of the connection the profile affects; either `all`, `client-side` or `server-side`. Sample: client-side \| \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: /Common/tcp \| \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: tcp \| \| \| protocol string \| queried \| IP protocol for which you want the virtual server to direct traffic. Sample: tcp \| \| \| rate\_class string \| queried \| Name of an existing rate class you want the virtual server to use to enforce a throughput policy for incoming network traffic. \| \| \| rate\_limit integer \| queried \| Maximum number of connections per second allowed for a virtual server. Sample: 34 \| \| \| rate\_limit\_destination\_mask integer \| queried \| Specifies a mask, in bits, to be applied to the destination address as part of the rate limiting. Sample: 32 \| \| \| rate\_limit\_mode string \| queried \| Indicates whether the rate limit is applied per virtual object, per source address, per destination address, or some combination thereof. Sample: object \| \| \| rate\_limit\_source\_mask integer \| queried \| Specifies a mask, in bits, to be applied to the source address as part of the rate limiting. \| \| \| security\_log\_profiles list / elements=string \| queried \| Specifies the log profile applied to the virtual server. Sample: ['/Common/global-network', '/Common/local-dos'] \| \| \| snat\_pool string \| queried \| Specifies the name of a LSN or SNAT pool used by the specified virtual server. Sample: /Common/pool1 \| \| \| snat\_type string \| queried \| Specifies the type of source address translation associated with the specified virtual server. Sample: none \| \| \| software\_syn\_cookie\_instances integer \| queried \| Software SYN Cookie Instances. \| \| \| source\_address string \| queried \| Specifies an IP address or network from which the virtual server will accept traffic. Sample: 0.0.0./0 \| \| \| source\_port\_behavior string \| queried \| Specifies whether the system preserves the source port of the connection. Sample: preserve \| \| \| status\_reason string \| queried \| If there is a problem with the status of the virtual, it is reported here. Sample: The children pool member(s) either don't have service checking... \| \| \| syn\_cache\_overflow integer \| queried \| SYN Cache Overflow. \| \| \| syn\_cookies\_status string \| queried \| SYN Cookies Status. Sample: not-activated \| \| \| total\_hardware\_accepted\_syn\_cookies integer \| queried \| SYN Cookies Total Hardware Accepted. \| \| \| total\_hardware\_syn\_cookies integer \| queried \| SYN Cookies Total Hardware. \| \| \| total\_requests integer \| queried \| Total requests. Sample: 8 \| \| \| total\_software\_accepted\_syn\_cookies integer \| queried \| SYN Cookies Total Software Accepted. \| \| \| total\_software\_rejected\_syn\_cookies integer \| queried \| Total Software Rejected. \| \| \| total\_software\_syn\_cookies integer \| queried \| Total Software SYN Cookies \| \| \| translate\_address boolean \| queried \| Enables or disables address translation for the virtual server. Sample: True \| \| \| translate\_port boolean \| queried \| Enables or disables port translation. Sample: True \| \| \| type string \| queried \| Virtual server type. Sample: standard \| \| \| vlans list / elements=string \| queried \| List of VLANs on which the virtual server is either enabled or disabled. Sample: ['/Common/vlan1', '/Common/vlan2'] \| \| vlans complex \| When `vlans` is specified in `gather_subset`. \| List of VLAN information. Sample: hash/dictionary of values \| \| \| auto\_lasthop string \| queried \| Allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. Sample: enabled \| \| \| cmp\_hash\_algorithm string \| queried \| Specifies how the traffic on the VLAN will be disaggregated. Sample: default \| \| \| description string \| queried \| Description of the VLAN. Sample: My vlan \| \| \| failsafe\_action string \| queried \| Action for the system to take when the fail-safe mechanism is triggered. Sample: reboot \| \| \| failsafe\_enabled boolean \| queried \| Whether failsafe is enabled or not. Sample: True \| \| \| failsafe\_timeout integer \| queried \| Number of seconds that an active unit can run without detecting network traffic on this VLAN before it starts a failover. Sample: 90 \| \| \| if\_index integer \| queried \| Index assigned to this VLAN. It is a unique identifier assigned for all objects displayed in the SNMP IF-MIB. Sample: 176 \| \| \| interfaces complex \| queried \| List of tagged or untagged interfaces and trunks that you want to configure for the VLAN. \| \| \| \| full\_path string \| queried \| Full name of the resource as known to the BIG-IP. Sample: 1.3 \| \| \| \| name string \| queried \| Relative name of the resource in the BIG-IP. Sample: 1.3 \| \| \| \| tagged boolean \| queried \| Whether the interface is tagged or not. \| \| \| learning\_mode string \| queried \| Whether switch ports placed in the VLAN are configured for switch learning, forwarding only, or dropped. Sample: enable-forward \| \| \| mtu integer \| queried \| Specific maximum transition unit (MTU) for the VLAN. Sample: 1500 \| \| \| sflow\_poll\_interval integer \| queried \| Maximum interval in seconds between two pollings. \| \| \| sflow\_poll\_interval\_global boolean \| queried \| Whether the global VLAN poll-interval setting overrides the object-level poll-interval setting. \| \| \| sflow\_sampling\_rate integer \| queried \| Ratio of packets observed to the samples generated. \| \| \| sflow\_sampling\_rate\_global boolean \| queried \| Whether the global VLAN sampling-rate setting overrides the object-level sampling-rate setting. Sample: True \| \| \| source\_check\_enabled boolean \| queried \| Specifies that only connections that have a return route in the routing table are accepted. Sample: True \| \| \| tag integer \| queried \| Tag number for the VLAN. Sample: 30 \| \| \| true\_mac\_address string \| queried \| Media access control (MAC) address for the lowest-numbered interface assigned to this VLAN. Sample: fa:16:3e:10:da:ff \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_asm_policy_server_technology – Manages Server Technology on an ASM policy f5networks.f5\_modules.bigip\_asm\_policy\_server\_technology – Manages Server Technology on an ASM policy ========================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_asm_policy_server_technology`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages Server Technology on ASM policies. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| name string / required \| Choices:* jQuery * Java Servlets/JSP * ASP * WebDAV * IIS * Front Page Server Extensions (FPSE) * ASP.NET * Microsoft Windows * Unix/Linux * Macromedia ColdFusion * WordPress * Apache Tomcat * Apache/NCSA HTTP Server * Outlook Web Access * PHP * Microsoft SQL Server * Oracle * MySQL * Lotus Domino * BEA Systems WebLogic Server * Macromedia JRun * Novell * Cisco * SSI (Server Side Includes) * Proxy Servers * CGI * Sybase/ASE * IBM DB2 * PostgreSQL * XML * Apache Struts * Elasticsearch * JBoss * Citrix * Node.js * Django * MongoDB * Ruby * JavaServer Faces (JSF) * Joomla * Jetty \| Specifies the name of the server technology to apply on, or remove from, the ASM policy. \| \| partition string \| Default:"Common" \| This parameter is only used when identifying an ASM policy. \| \| policy\_name string / required \| \| Specifies the name of an existing ASM policy to add or remove a server technology to. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * This module is primarily used as a component of configuring an ASM policy in the Ansible Galaxy ASM Policy Role. * Requires BIG-IP >= 13.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add Server Technology to ASM Policy bigip_asm_policy_server_technology: name: Joomla policy_name: FooPolicy provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove Server Technology from ASM Policy bigip_asm_policy_server_technology: name: Joomla policy_name: FooPolicy state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| name string \| changed \| The name of Server Technology added/removed on the ASM policy. Sample: Joomla \| \| policy\_name string \| changed \| The name of the ASM policy Sample: FooPolicy \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigiq_utility_license_assignment – Manage utility license assignment on BIG-IPs from a BIG-IQ f5networks.f5\_modules.bigiq\_utility\_license\_assignment – Manage utility license assignment on BIG-IPs from a BIG-IQ ======================================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_utility_license_assignment`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages the assignment of utility licenses on a BIG-IQ. Assignment means the license is assigned to a BIG-IP, or it needs to be assigned to a BIG-IP. Additionally, this module supports revoking the assignments from BIG-IP devices. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| device string / required \| \| When `managed` is `no`, specifies the address, or hostname, where the BIG-IQ can reach the remote device to register. When `managed` is `yes`, specifies the managed device, or device UUID, you want to register. If `managed` is `yes`, it is very important you do not have more than one device with the same name. BIG-IQ internally recognizes devices by their ID, and therefore, this module cannot guarantee the correct device will be registered. The device returned is the device that is used. \| \| device\_password string \| \| The password of the `device_username`. When `managed` is `no`, this parameter is required. \| \| device\_port integer \| Default:443 \| Specifies the port of the remote device to connect to. If this parameter is not specified, the default is `443`. \| \| device\_username string \| \| The username used to connect to the remote device. This username should be one that has sufficient privileges on the remote device to do licensing. Usually this is the `Administrator` role. When `managed` is `no`, this parameter is required. \| \| key string / required \| \| The registration key from which you want choose an offering. \| \| managed boolean \| Choices:* no * yes \| Whether the specified device is a managed or un-managed device. When `state` is `present`, this parameter is required. \| \| offering string / required \| \| Name of the license offering to assign to the device. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the device is assigned the specified license. When `absent`, ensures the license is revokes from the remote device and freed on the BIG-IQ. \| \| unit\_of\_measure string \| Choices:* hourly ← * daily * monthly * yearly \| Sets the rate at which this license usage is billed. Depending on your license, you may have different units of measure available to you. If a particular unit is not available to you, the module notifies you at licensing time. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Register an unmanaged device bigiq_utility_license_assignment: key: XXXX-XXXX-XXXX-XXXX-XXXX offering: F5-BIG-MSP-AFM-10G-LIC device: 1.1.1.1 managed: no device_username: admin device_password: secret state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Register a managed device, by name bigiq_utility_license_assignment: key: XXXX-XXXX-XXXX-XXXX-XXXX offering: F5-BIG-MSP-AFM-10G-LIC device: bigi1.foo.com managed: yes state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Register a managed device, by UUID bigiq_utility_license_assignment: key: XXXX-XXXX-XXXX-XXXX-XXXX offering: F5-BIG-MSP-AFM-10G-LIC device: 7141a063-7cf8-423f-9829-9d40599fa3e0 managed: yes state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_gtm_pool – Manages F5 BIG-IP GTM pools f5networks.f5\_modules.bigip\_gtm\_pool – Manages F5 BIG-IP GTM pools ===================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_pool`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP GTM (now BIG-IP DNS) pools. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| alternate\_lb\_method string \| Choices:* round-robin * return-to-dns * none * ratio * topology * static-persistence * global-availability * virtual-server-capacity * packet-rate * drop-packet * fallback-ip * virtual-server-score \| The load balancing mode the system tries if the `preferred_lb_method` is unsuccessful in picking a pool. \| \| availability\_requirements dictionary \| \| If you activate more than one health monitor, specifies the number of health monitors that must receive successful responses in order for the link to be considered available. \| \| \| at\_least integer \| \| Specifies the minimum number of active health monitors that must be successful before the link is considered up. This parameter is only relevant when a `type` of `at_least` is used. This parameter will be ignored if a type of either `all` or `require` is used. \| \| \| number\_of\_probers integer \| \| Specifies the number of probers that should be used when running probes. When creating a new virtual server, if this parameter is specified, the `number_of_probes` parameter must also be specified. The value of this parameter should always be higher than, or equal to, the value of `number_of_probers`. This parameter is only relevant when a `type` of `require` is used. This parameter will be ignored if a type of either `all` or `at_least` is used. \| \| \| number\_of\_probes integer \| \| Specifies the minimum number of probes that must succeed for this server to be declared up. When creating a new virtual server, if this parameter is specified, the `number_of_probers` parameter must also be specified. The value of this parameter should always be lower than, or equal to, the value of `number_of_probers`. This parameter is only relevant when a `type` of `require` is used. This parameter will be ignored if a type of either `all` or `at_least` is used. \| \| \| type string / required \| Choices:* all * at\_least * require \| Monitor rule type when `monitors` is specified. When creating a new pool, if this value is not specified, the default of 'all' will be used. \| \| fallback\_ip string \| \| Specifies the IPv4 or IPv6 address of the server to which the system directs requests when it cannot use one of its pools to do so. Note that the system uses the fallback IP only if you select the `fallback_ip` load balancing method. \| \| fallback\_lb\_method string \| Choices:* round-robin * return-to-dns * ratio * topology * static-persistence * global-availability * virtual-server-capacity * least-connections * lowest-round-trip-time * fewest-hops * packet-rate * cpu * completion-rate * quality-of-service * kilobytes-per-second * drop-packet * fallback-ip * virtual-server-score * none \| The load balancing mode the system tries if both the `preferred_lb_method` and `alternate_lb_method`s are unsuccessful in picking a pool. \| \| max\_answers\_returned integer \| \| Specifies the maximum number of available virtual servers the system lists in a response. The maximum is 500. \| \| members list / elements=dictionary \| \| Members to assign to the pool. The order of the members in this list is the order they will be listed in the pool. \| \| \| server string / required \| \| Name of the server which the pool member is a part of. \| \| \| virtual\_server string / required \| \| Name of the virtual server, associated with the server, the pool member is a part of. \| \| monitors list / elements=string \| \| Specifies the health monitors the system currently uses to monitor this resource. When `availability_requirements.type` is `require`, you may only have a single monitor in the `monitors` list. \| \| name string / required \| \| Name of the GTM pool. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| preferred\_lb\_method string \| Choices:* round-robin * return-to-dns * ratio * topology * static-persistence * global-availability * virtual-server-capacity * least-connections * lowest-round-trip-time * fewest-hops * packet-rate * cpu * completion-rate * quality-of-service * kilobytes-per-second * drop-packet * fallback-ip * virtual-server-score \| The load balancing mode the system tries first. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent * enabled * disabled \| Pool state. When `present`, ensures the pool is created and enabled. When `absent`, ensures the pool is removed from the system. When `enabled` or `disabled`, ensures the pool is enabled or disabled (respectively) on the remote device. \| \| ttl integer \| \| Specifies the number of seconds the IP address, once found, is valid. \| \| type string / required \| Choices:* a * aaaa * cname * mx * naptr * srv \| The type of GTM pool you want to create. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a GTM pool bigip_gtm_pool: name: my_pool type: a provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Disable pool bigip_gtm_pool: state: disabled name: my_pool type: a provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| alternate\_lb\_method string \| changed \| New alternate load balancing method for the pool. Sample: drop-packet \| \| fallback\_ip string \| changed \| New fallback IP used when load balacing using the `fallback_ip` method. Sample: 10.10.10.10 \| \| fallback\_lb\_method string \| changed \| New fallback load balancing method for the pool. Sample: fewest-hops \| \| max\_answers\_returned integer \| changed \| The new Maximum Answers Returned value. Sample: 25 \| \| members complex \| changed \| List of members in the pool. \| \| \| server string \| changed \| The name of the server portion of the member. \| \| \| virtual\_server string \| changed \| The name of the virtual server portion of the member. \| \| monitors list / elements=string \| changed \| The new list of monitors for the resource. Sample: ['/Common/monitor1', '/Common/monitor2'] \| \| preferred\_lb\_method string \| changed \| New preferred load balancing method for the pool. Sample: topology \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_ssl_key – Import/Delete SSL keys from BIG-IP f5networks.f5\_modules.bigip\_ssl\_key – Import/Delete SSL keys from BIG-IP =========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ssl_key`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module imports/deletes SSL keys on a BIG-IP. Keys can be imported from key files on the local disk, in PEM format. Requirements ------------ The below requirements are needed on the host that executes this module. * BIG-IP >= v12 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| content string \| \| Sets the contents of a key directly to the specified value. This is used with lookup plugins or for anything with formatting or templating. This must be provided when `state` is `present`. aliases: key\_content \| \| name string / required \| \| The name of the key. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| passphrase string \| \| Passphrase on key. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the key is uploaded to the device. When `absent`, ensures the key is removed from the device. If the key is currently in use, the module is not able to remove the key. \| Notes ----- Note * This module does not behave like other modules that you might include in roles, where referencing files or templates first looks in the role’s files or templates directory. To have it behave that way, use the Ansible file or template lookup (see Examples). The lookups behave as expected in a role context. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Use a file lookup to import key bigip_ssl_key: name: key-name state: present content: "{{ lookup('file', '/path/to/key.key') }}" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Delete key bigip_ssl_key: name: key-name state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| key\_checksum string \| changed and created \| SHA1 checksum of the key. Sample: cf23df2207d99a74fbe169e3eba035e633b65d94 \| \| key\_filename string \| created \| The name of the SSL certificate key. The `key_filename` and `cert_filename` will be similar to each other, however the `key_filename` will have a `.key` extension. Sample: cert1.key \| \| key\_source\_path string \| created \| Path on BIG-IP where the source of the key is stored. Sample: /var/config/rest/downloads/cert1.key \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_device_syslog – Manage system-level syslog settings on BIG-IP f5networks.f5\_modules.bigip\_device\_syslog – Manage system-level syslog settings on BIG-IP ============================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_syslog`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage system-level syslog settings on BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_priv\_from string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the lowest level of messages about user authentication to include in the system log. \| \| auth\_priv\_to string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the highest level of messages about user authentication to include in the system log. \| \| console\_log boolean \| Choices:* no * yes \| Enables or disables logging emergency syslog messages to the console. \| \| cron\_from string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the lowest level of messages about time-based scheduling to include in the system log. \| \| cron\_to string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the highest level of messages about time-based scheduling to include in the system log. \| \| daemon\_from string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the lowest level of messages about daemon performance to include in the system log. \| \| daemon\_to string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the highest level of messages about daemon performance to include in the system log. \| \| include string \| \| Syslog-NG configuration to include in the device syslog config. \| \| iso\_date boolean \| Choices:* no * yes \| Enables or disables the ISO date format for messages in the log files. \| \| kern\_from string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the lowest level of kernel messages to include in the system log. \| \| kern\_to string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the highest level of kernel messages to include in the system log. \| \| local6\_from string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the lowest error level for messages from the local6 facility to include in the log. \| \| local6\_to string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the highest error level for messages from the local6 facility to include in the log. \| \| mail\_from string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the lowest level of mail log messages to include in the system log. \| \| mail\_to string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the highest level of mail log messages to include in the system log. \| \| messages\_from string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the lowest level of system messages to include in the system log. \| \| messages\_to string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the highest level of system messages to include in the system log. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| user\_log\_from string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the lowest level of user account messages to include in the system log. \| \| user\_log\_to string \| Choices:* alert * crit * debug * emerg * err * info * notice * warning \| Specifies the highest level of user account messages to include in the system log. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a syslog config bigip_device_syslog: name: foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| auth\_priv\_from string \| changed \| The new lowest user authentication logging level. Sample: alert \| \| auth\_priv\_to string \| changed \| The new highest user authentication logging level. Sample: emerg \| \| console\_log boolean \| changed \| Whether logging to the console is enabled or not. Sample: True \| \| cron\_from string \| changed \| The new lowest time-based scheduling logging level. Sample: emerg \| \| cron\_to string \| changed \| The new highest time-based scheduling logging level. Sample: alert \| \| daemon\_from string \| changed \| The new lowest daemon performance logging level. Sample: alert \| \| daemon\_to string \| changed \| The new highest daemon performance logging level. Sample: alert \| \| include string \| changed \| The new extra syslog-ng configuration to include in syslog config. Sample: filter f\_remote\_syslog { not (facility(local6)) }; \| \| iso\_date boolean \| changed \| Whether ISO date format in logs is enabled or not. \| \| kern\_from string \| changed \| The new lowest kernel messages logging level. Sample: alert \| \| kern\_to string \| changed \| The new highest kernel messages logging level. Sample: alert \| \| local6\_from string \| changed \| The new lowest local6 facility logging level. Sample: alert \| \| local6\_to string \| changed \| The new highest local6 facility logging level. Sample: alert \| \| mail\_from string \| changed \| The new lowest mail log logging level. Sample: alert \| \| mail\_to string \| changed \| The new highest mail log logging level. Sample: alert \| \| messages\_from string \| changed \| The new lowest system logging level. Sample: alert \| \| messages\_to string \| changed \| The new highest system logging level. Sample: alert \| \| user\_log\_from string \| changed \| The new lowest user account logging level. Sample: alert \| \| user\_log\_to string \| changed \| The new highest user account logging level. Sample: alert \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_dns_zone – Manage DNS zones on BIG-IP f5networks.f5\_modules.bigip\_dns\_zone – Manage DNS zones on BIG-IP ==================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_dns_zone`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage DNS zones on BIG-IP. The zones managed here are primarily used for configuring DNS Express on a BIG-IP. This module does not configure zones that are found in BIG-IP ZoneRunner. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| dns\_express dictionary \| \| DNS express related settings. \| \| \| allow\_notify\_from list / elements=string \| \| Specifies the IP addresses from which the system accepts NOTIFY messages for this DNS Express zone. \| \| \| enabled boolean \| Choices:* no * yes \| Specifies the current status of the DNS Express zone. \| \| \| notify\_action string \| Choices:* consume * bypass * repeat \| Specifies the action the system takes when a NOTIFY message is received for this DNS Express zone. If a TSIG key is configured for the zone, the signature is only validated for `consume` and `repeat` actions. When `consume`, the NOTIFY message is seen only by DNS Express. When `bypass`, the NOTIFY message does not go to DNS Express, but instead goes to a back-end DNS server (subject to the value of the Unhandled Query Action configured in the DNS profile applied to the listener that handles the DNS request). When `repeat`, the NOTIFY message goes to both DNS Express and any back-end DNS server. \| \| \| response\_policy boolean \| Choices:* no * yes \| Specifies whether this DNS Express zone is a DNS response policy zone (RPZ). \| \| \| server string \| \| Specifies the back-end authoritative DNS server from which the BIG-IP system receives AXFR zone transfers for the DNS Express zone. \| \| \| verify\_tsig boolean \| Choices:* no * yes \| Specifies whether the system verifies the identity of the authoritative nameserver that sends updated information for this DNS Express zone. \| \| name string / required \| \| Specifies the name of the DNS zone. The name must begin with a letter and contain only letters, numbers, and the underscore character. \| \| nameservers list / elements=string \| \| Specifies the DNS nameservers to which the system sends NOTIFY messages. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| tsig\_server\_key string \| \| Specifies the TSIG key the system uses to authenticate the back-end DNS authoritative server that sends AXFR zone transfers to the BIG-IP system. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a DNS zone for DNS express bigip_dns_zone: name: zone.foo.com dns_express: enabled: yes server: dns-lab allow_notify_from: - 192.168.39.10 notify_action: consume verify_tsig: no response_policy: no provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Disable DNS express zone, change server, and modify notify_action to bypass bigip_dns_zone: name: zone.foo.com dns_express: enabled: no server: foo1.server.com allow_notify_from: - 192.168.39.10 notify_action: bypass verify_tsig: no response_policy: no provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Add nameservers bigip_dns_zone: name: zone.foo.com nameservers: - foo1.nameserver.com - foo2.nameserver.com - foo3.nameserver.com provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove nameserver bigip_dns_zone: name: zone.foo.com nameservers: - foo1.nameserver.com - foo2.nameserver.com provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove all nameservers bigip_dns_zone: name: zone.foo.com nameservers: none provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Add tsig_server_key bigip_dns_zone: name: zone.foo.com tsig_server_key: key1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove tsig_server_key bigip_dns_zone: name: zone.foo.com tsig_server_key: none provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove zone bigip_dns_zone: name: zone.foo.com state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| allow\_notify\_from list / elements=string \| changed \| The new DNS Express Allow NOTIFY From value. Sample: ['1.1.1.1', '2.2.2.2'] \| \| enabled boolean \| changed \| Whether the zone is enabled or not. Sample: True \| \| express\_server string \| changed \| The new DNS Express Server value. Sample: server1 \| \| nameservers list / elements=string \| changed \| The new Zone Transfer Clients Nameservers value. Sample: ['/Common/server1', '/Common/server2'] \| \| notify\_action string \| changed \| The new DNS Express Notify Action value. Sample: consume \| \| response\_policy boolean \| changed \| The new DNS Express Response Policy value. \| \| tsig\_server\_key string \| changed \| The new TSIG Server Key value. Sample: /Common/key1 \| \| verify\_tsig boolean \| changed \| The new DNS Express Verify Notify TSIG value. Sample: True \| ### Authors * Tim Rupp (@caphrim007) * Greg Crosby (@crosbygw)	programming_docs
ansible f5networks.f5_modules.bigiq_regkey_license – Manages licenses in a BIG-IQ registration key pool f5networks.f5\_modules.bigiq\_regkey\_license – Manages licenses in a BIG-IQ registration key pool ================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_regkey_license`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages licenses in a BIG-IQ registration key pool. Requirements ------------ The below requirements are needed on the host that executes this module. * BIG-IQ >= 5.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accept\_eula boolean \| Choices:* no * yes \| A key that signifies you accept the F5 EULA for this license. A copy of the EULA can be found here https://askf5.f5.com/csp/article/K12902 This is required when `state` is `present`. \| \| description string \| \| Description of the license. \| \| license\_key string / required \| \| The license key to put in the pool. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| regkey\_pool string / required \| \| The registration key pool in which you want to place the license. You must give your registration pools unique names. While BIG-IQ does not require this, this module does. If you do not, the behavior of the module is undefined and you may end up putting licenses in the wrong registration key pool. \| \| state string \| Choices:* absent * present ← \| The state of the regkey license in the pool on the system. When `present`, guarantees the license exists in the pool. When `absent`, removes the license from the pool. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add a registration key license to a pool bigiq_regkey_license: regkey_pool: foo-pool license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX accept_eula: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove a registration key license from a pool bigiq_regkey_license: regkey_pool: foo-pool license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the license key. Sample: My license for BIG-IP 1 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_dns_nameserver – Manage LTM DNS nameservers on a BIG-IP f5networks.f5\_modules.bigip\_dns\_nameserver – Manage LTM DNS nameservers on a BIG-IP ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_dns_nameserver`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages LTM DNS nameservers on a BIG-IP. These nameservers form part of what is known as DNS Express on a BIG-IP. This module does not configure GTM (DNS module) related functionality, nor does it configure system-level name servers that affect the ability of the base system to resolve DNS names. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| Specifies the IP address on which the DNS nameserver (client) or back-end DNS authoritative server (DNS Express server) listens for DNS messages. When creating a new nameserver, if this value is not specified, the default is `127.0.0.1`. \| \| name string / required \| \| Specifies the name of the nameserver. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| route\_domain string \| \| Specifies the local route domain the DNS nameserver (client) or back-end DNS authoritative server (DNS Express server) uses for outbound traffic. When creating a new nameserver, if this value is not specified, the default is `0`. \| \| service\_port string \| \| Specifies the service port on which the DNS nameserver (client) or back-end DNS authoritative server (DNS Express server) listens for DNS messages. When creating a new nameserver, if this value is not specified, the default is `53`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| tsig\_key string \| \| Specifies the TSIG key the system uses to communicate with this DNS nameserver (client) or back-end DNS authoritative server (DNS Express server) for AXFR zone transfers. If the nameserver is a client, then the system uses this TSIG key to verify the request and sign the response. If this nameserver is a DNS Express server, then this TSIG key must match the TSIG key for the zone on the back-end DNS authoritative server. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a nameserver bigip_dns_nameserver: name: foo address: 10.10.10.10 service_port: 53 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address string \| changed \| Address which the nameserver listens for DNS messages. Sample: 127.0.0.1 \| \| service\_port integer \| changed \| Service port on which the nameserver listens for DNS messages. Sample: 53 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_software_install – Install software images on a BIG-IP f5networks.f5\_modules.bigip\_software\_install – Install software images on a BIG-IP ===================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_software_install`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Install new software images on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| block\_device\_image string added in 1.2.0 of f5networks.f5\_modules \| \| Image to install on the remote device. In the case of a VCMP guest, ensure this image is present on the VCMP host and is referenced from there, and not from the VCMP guest. An ISO image directly uploaded to the VCMP guest will not work. \| \| image string \| \| Image to install on the remote device. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* activated ← * installed \| When `installed`, ensures the software is installed on the volume and the volume is set to be booted from. The device is not rebooted into the new software. When `activated`, performs the same operation as `installed`, but the system is rebooted to the new software. \| \| type string added in 1.2.0 of f5networks.f5\_modules \| Choices:* standard ← * vcmp \| The type of the BIG-IP. Defaults to `standard`, the other choice is `vcmp`. \| \| volume string \| \| The volume on which to install the software image. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Ensure an existing image is installed in specified volume bigip_software_install: image: BIGIP-13.0.0.0.0.1645.iso volume: HD1.2 state: installed provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Ensure an existing image is activated in specified volume bigip_software_install: image: BIGIP-13.0.0.0.0.1645.iso state: activated volume: HD1.2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Ensure an existing image is activated in specified volume in a VCMP guest bigip_software_install: block_device_image: BIGIP-13.0.0.0.0.1645.iso type: vcmp state: activated volume: HD1.2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) * Nitin Khanna (@nitinthewiz) ansible f5networks.f5_modules.bigip_profile_http – Manage HTTP profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_http – Manage HTTP profiles on a BIG-IP ============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_http`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage HTTP profiles on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accept\_xff boolean \| Choices:* no * yes \| Enables or disables trusting the client IP address, and statistics from the client IP address, based on the request's XFF (X-forwarded-for) headers, if they exist. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| description string \| \| Description of the profile. \| \| dns\_resolver string \| \| Specifies the name of a configured DNS resolver, this option is mandatory when `proxy_type` is set to `explicit`. Format of the name can be either be prepended by partition (`/Common/foo`), or specified just as an object name (`foo`). To remove the entry, you can set a value of `none` or `''`, however the profile `proxy_type` must not be set as `explicit`. \| \| encrypt\_cookie\_secret string \| \| Passphrase for cookie encryption. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| encrypt\_cookies list / elements=string \| \| Cookie names for the system to encrypt. To remove the entry completely, set a value of `none` or `''`. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| enforcement dictionary \| \| Specifies protocol enforcement settings for the HTTP profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| excess\_client\_headers string \| Choices:* reject * pass-through \| Specifies the behavior when too many client headers are received. If set to `pass-through`, it switches to pass-through mode, when `reject`, the connection is rejected. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| excess\_server\_headers string \| Choices:* reject * pass-through \| Specifies the behavior when too many server headers are received. If set to `pass-through`, it switches to pass-through mode, when `reject` the connection is rejected. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| known\_methods list / elements=string \| \| Specifies which HTTP methods count as being known, removing RFC-defined methods from this list will cause the HTTP filter to not recognize them. The default list provided with the system include: `CONNECT`, `DELETE`, `GET`, `HEAD`, `LOCK`, `OPTIONS`, `POST`, `PROPFIND`, `PUT`, `TRACE` ,`UNLOCK`. The list can be appended by by specifying the `default` keyword as one of the list elements. The `default` keyword can also be used to restore the default `known_methods` on the system. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| max\_header\_count string \| \| Specifies the maximum number of headers allowed in HTTP request/response. The valid value range is between 16 and 4096 inclusive. When set to `default`, the value is `64`. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| max\_header\_size string \| \| Specifies the maximum header size specified in bytes. The valid value range is between 0 and 4294967295 inclusive. When set to `default`, the value is `32768` bytes When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| max\_requests string \| \| Specifies the number of requests the system accepts on a per-connection basis. The valid value range is between 0 and 4294967295 inclusive. When set to `default`, the value is `0`, which means the system will not limit the number of requests per connection. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| oversize\_client\_headers string \| Choices:* reject * pass-through \| Specifies the behavior when too-large client headers are received. If set to `pass-through`,it switches to pass-through mode, when `reject` the connection is rejected. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| oversize\_server\_headers string \| Choices:* reject * pass-through \| Specifies the behavior when too-large server headers are received. If set to `pass-through`, it switches to pass-through mode, when `reject` the connection is rejected. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| pipeline string \| Choices:* allow * reject * pass-through \| Enables HTTP/1.1 pipelining, allowing clients to make requests even when prior requests have not received a response. In order for this to succeed, destination servers must include support for pipelining. If set to `pass-through`, pipelined data causes the BIG-IP to immediately switch to pass-through mode and disable the HTTP filter. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| truncated\_redirects boolean \| Choices:* no * yes \| Specifies what happens if a truncated redirect is seen from a server. If `yes`, the redirect is forwarded to the client, otherwise the malformed HTTP is silently ignored. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| unknown\_method string \| Choices:* allow * reject * pass-through \| Specifies whether to allow, reject or switch to pass-through mode when an unknown HTTP method is parsed. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| fallback\_host string \| \| Specifies an HTTP fallback host. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| fallback\_status\_codes list / elements=string \| \| Specifies one or more HTTP error codes from server responses that should trigger a redirection to the fallback host. The accepted valid error codes are as defined by RFC2616. The codes can be specified as individual items or as valid ranges, for example `400-417` or `500-505`. Mixing response code range across error types is invalid, for example defining `400-505` will raise an error. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| header\_erase string \| \| The name of a header in an HTTP request, which the system removes from request. To remove the entry completely, set a value of `none` or `''`. The format of the header must be in `KEY:VALUE` format, otherwise an error occurs. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| header\_insert string \| \| A string the system inserts as a header in an HTTP request. To remove the entry completely, set a value of `none` or `''`. The format of the header must be in `KEY:VALUE` format, otherwise an error occurs. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| hsts\_mode boolean \| Choices:* no * yes \| When set to `yes`, enables the HSTS settings. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| include\_subdomains boolean \| Choices:* no * yes \| When set to `yes`, applies the HSTS policy to the HSTS host and its sub-domains. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| insert\_xforwarded\_for boolean \| Choices:* no * yes \| Specifies the system inserts an X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| maximum\_age string \| \| Specifies the maximum length of time, in seconds, that HSTS functionality requests clients only use HTTPS to connect to the current host and any sub-domains of the current host's domain name. The accepted value range is `0 - 4294967295` seconds. A value of `0` seconds re-enables plaintext HTTP access, while specifying `indefinite` sets it to the maximum value. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| name string / required \| \| Specifies the name of the profile. \| \| oneconnect\_transformations boolean \| Choices:* no * yes \| Enables the system to perform HTTP header transformations for keeping server-side connections open. This feature requires a OneConnect profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `http` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| proxy\_type string \| Choices:* reverse * transparent * explicit \| Specifies the proxy mode for the profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| redirect\_rewrite string \| Choices:* none * all * matching * nodes \| Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses. When set to `none`, the system will not rewrite the URI in any HTTP redirect responses. When set to `all`, the system rewrites the URI in all HTTP redirect responses. When set to `matching`, the system rewrites the URI in any HTTP redirect responses that match the request URI. When set to `nodes`, if the URI contains a node IP address instead of a host name, the system changes it to the virtual server address. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| request\_chunking string \| Choices:* rechunk * selective * preserve * sustain * unchunk \| Specifies how to handle chunked and unchunked requests. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| response\_chunking string \| Choices:* rechunk * selective * preserve * sustain * unchunk \| Specifies how to handle chunked and unchunked responses. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| server\_agent\_name string \| \| Specifies the string used as the server name in traffic generated by BIG-IP. To remove the entry completely, set a value of `none` or `''`. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| sflow dictionary \| \| Specifies sFlow settings for the HTTP profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| poll\_interval integer \| \| Specifies the maximum interval in seconds between two pollings. The valid value range is between 0 and 4294967295 seconds inclusive. For this setting to take effect the `poll_interval_global` parameter must be set to `no`. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| poll\_interval\_global boolean \| Choices:* no * yes \| Specifies whether the global HTTP poll-interval setting overrides the object-level `poll-interval` setting. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| sampling\_rate integer \| \| Specifies the ratio of packets observed to the samples generated. For example, a sampling rate of `2000` specifies 1 sample will be randomly generated for every 2000 packets observed. The valid value range is between 0 and 4294967295 packets inclusive. For this setting to take effect the `sampling_rate_global` parameter must be set to `no`. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| \| sampling\_rate\_global boolean \| Choices:* no * yes \| Specifies whether the global HTTP sampling-rate setting overrides the object-level sampling-rate setting. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will update passwords if the `encrypt_cookie_secret` is specified. `on_create` will only set the password for newly created profiles. \| \| xff\_alternative\_names list / elements=string \| \| Specifies alternative XFF headers instead of the default X-forwarded-for header. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create HTTP profile bigip_profile_http: name: my_profile insert_xforwarded_for: yes redirect_rewrite: all state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove HTTP profile bigip_profile_http: name: my_profile state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add HTTP profile for transparent proxy bigip_profile_http: name: my_profile proxy_type: transparent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| accept\_xff boolean \| changed \| Enables or disables trusting the client IP address and statistics from the client IP address. Sample: True \| \| description string \| changed \| Description of the profile. Sample: My profile \| \| dns\_resolver string \| changed \| Configured dns resolver. Sample: /Common/FooBar \| \| encrypt\_cookies list / elements=string \| changed \| Cookie names to encrypt. Sample: ['MyCookie1', 'MyCookie2'] \| \| enforcement complex \| changed \| Specifies protocol enforcement settings for the HTTP profile. Sample: hash/dictionary of values \| \| \| excess\_server\_headers string \| changed \| Specifies the behavior when too many server headers are received. Sample: pass-through \| \| \| known\_methods list / elements=string \| changed \| The list of known HTTP methods. Sample: ['default', 'FOO', 'BAR'] \| \| \| max\_header\_count string \| changed \| The maximum number of headers allowed in HTTP request/response. Sample: 4096 \| \| \| max\_header\_size string \| changed \| The maximum header size specified in bytes. Sample: default \| \| \| max\_requests string \| changed \| The number of requests the system accepts on a per-connection basis. Sample: default \| \| \| oversize\_client\_headers string \| changed \| Specifies the behavior when too-large client headers are received. Sample: reject \| \| \| oversize\_server\_headers string \| changed \| Specifies the behavior when too-large server headers are received. Sample: reject \| \| \| pipeline string \| changed \| Allows, rejects. or switches to pass-through mode when dealing with pipelined data. Sample: allow \| \| \| truncated\_redirects boolean \| changed \| Specifies what happens if a truncated redirect is seen from a server. Sample: True \| \| \| unknown\_method string \| changed \| Allows, rejects. or switches to pass-through mode when an unknown HTTP method is parsed. Sample: allow \| \| fallback\_host string \| changed \| Specifies an HTTP fallback host. Sample: foobar.com \| \| fallback\_status\_codes list / elements=string \| changed \| HTTP error codes from server responses that should trigger a redirection to the fallback host. Sample: ['400-404', '500', '501'] \| \| header\_erase string \| changed \| The name of a header in an HTTP request, which the system removes from request. Sample: FOO:BAR \| \| header\_insert string \| changed \| The string the system inserts as a header in an HTTP request. Sample: FOO:BAR \| \| hsts\_mode boolean \| changed \| Enables the HSTS settings. \| \| include\_subdomains boolean \| changed \| Applies the HSTS policy to the HSTS host and its sub-domains. Sample: True \| \| insert\_xforwarded\_for boolean \| changed \| Insert X-Forwarded-For-Header. Sample: True \| \| maximum\_age string \| changed \| The maximum length of time, in seconds, that HSTS functionality requests that clients only use HTTPS. Sample: indefinite \| \| oneconnect\_transformations boolean \| changed \| Enables or disables HTTP header transformations. \| \| parent string \| changed \| Specifies the profile from which this profile inherits settings. Sample: /Common/http \| \| proxy\_type string \| changed \| Specify proxy mode of the profile. Sample: explicit \| \| redirect\_rewrite string \| changed \| Rewrite URI that are part of 3xx responses. Sample: all \| \| request\_chunking string \| changed \| Specifies how to handle chunked and unchunked requests. Sample: rechunk \| \| response\_chunking string \| changed \| Specifies how to handle chunked and unchunked responses. Sample: rechunk \| \| server\_agent\_name string \| changed \| The string used as the server name in traffic generated by BIG-IP. Sample: foobar \| \| sflow complex \| changed \| Specifies sFlow settings for the HTTP profile. Sample: hash/dictionary of values \| \| \| poll\_interval integer \| changed \| Specifies the maximum interval in seconds between two pollings. Sample: 30 \| \| \| poll\_interval\_global boolean \| changed \| Enables/Disables overriding HTTP poll-interval setting. Sample: True \| \| \| sampling\_rate integer \| changed \| Specifies the ratio of packets observed to the samples generated. Sample: 2000 \| \| \| sampling\_rate\_global boolean \| changed \| Enables/Disables overriding HTTP sampling-rate setting. Sample: True \| \| xff\_alternative\_names list / elements=string \| changed \| Specifies alternative XFF headers instead of the default X-forwarded-for header. Sample: ['FooBar', 'client1'] \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_log_destination – Manages log destinations on a BIG-IP. f5networks.f5\_modules.bigip\_log\_destination – Manages log destinations on a BIG-IP. ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_log_destination`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages log destinations on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| Specifies the IP address that will receive messages from the specified local Log Destination. This parameter is only available when `type` is `management-port`. When creating a new log destination and `type` is `management-port`, this parameter is required. \| \| description string \| \| The description of the log destination. \| \| distribution string \| Choices:* adaptive * balanced * replicated \| Specifies the distribution method used by the Remote High Speed Log destination to send messages to pool members. When `adaptive`, connections to pool members will be added as required to provide enough logging bandwidth. This can have the undesirable effect of logs accumulating on only one pool member when it provides sufficient logging bandwidth on its own. When `balanced`, sends each successive log to a new pool member, balancing the logs among them according to the pool's load balancing method. When `replicated`, replicates each log to all pool members, for redundancy. When creating a new log destination and `type` is `remote-high-speed-log`, if this parameter is not specified, the default is `adaptive`. \| \| forward\_to string \| \| When `type` is `remote-syslog`, specifies the management port log destination, which will be used to forward the logs to a single log server, or a remote high-speed log destination, which will be used to forward the logs to a pool of remote log servers. When `type` is `splunk` or `arcsight`, specifies the log destination to which logs are forwarded. This log destination may be a management port destination, a remote high-speed log destination, or a remote Syslog destination which is configured to send logs to an ArcSight or Splunk server. When creating a new log destination and `type` is `remote-syslog`, `splunk`, or `arcsight`, this parameter is required. \| \| name string / required \| \| Specifies the name of the log destination. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| pool string \| \| When `type` is `remote-high-speed-log`, specifies the existing pool of remote high-speed log servers where logs will be sent. When `type` is `ipfix`, specifies the existing LTM pool of remote IPFIX collectors. Any BIG-IP application that uses this log destination sends its IP-traffic logs to this pool of collectors. When creating a new destination and `type` is `remote-high-speed-log` or `ipfix`, this parameter is required. \| \| port integer \| \| Specifies the port of the IP address that will receive messages from the specified local Log Destination. This parameter is only available when `type` is `management-port`. When creating a new log destination and `type` is `management-port`, this parameter is required. \| \| protocol string \| Choices:* tcp * udp * ipfix * netflow-9 \| When `type` is `remote-high-speed-log`, specifies the protocol for the system to use to send logs to the pool of remote high-speed log servers, where the logs are stored. When `type` is `ipfix`, can be IPFIX or Netflow v9, depending on the type of collectors you have in the pool that you specify. When `type` is `management-port`, specifies the protocol used to send messages to the specified location. When `type` is `management-port`, only `tcp` and `udp` are valid values. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| server\_ssl\_profile string \| \| If the `transport_profile` is a TCP profile, you can use this field to choose a Secure Socket Layer (SSL) profile for sending logs to the IPFIX collectors. An SSL server profile defines how to communicate securely over SSL or Transport Layer Security (TLS). This parameter is only available when `type` is `ipfix`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| syslog\_format string \| Choices:* bsd-syslog * syslog * legacy-bigip * rfc5424 * rfc3164 \| Specifies the method to use to format the logs associated with the remote Syslog log destination. When creating a new log destination (and `type` is `remote-syslog`), if this parameter is not specified, the default is `bsd-syslog`. The `syslog` and `rfc5424` choices are the same. The `bsd-syslog` and `rfc3164` choices are the same. \| \| template\_delete\_delay integer \| \| Enter the time (in seconds) that the BIG-IP device should pause between deleting an obsolete IPFIX template and reusing its template ID. This feature is useful for systems where you use iRules to create customized IPFIX templates. \| \| template\_retransmit\_interval integer \| \| Enter the time (in seconds) between each transmission of IPFIX templates to the pool of IPFIX collectors. The logging destination periodically retransmits all of its IPFIX templates at the interval you set in this field. These retransmissions are helpful for UDP, a lossy transport mechanism. This parameter is only available when `type` is `ipfix`. \| \| transport\_profile string \| \| Is a transport profile based on either TCP or UDP. This profile defines the TCP or UDP options used to send IP-traffic logs to the pool of collectors. This parameter is only available when `type` is `ipfix`. \| \| type string / required \| Choices:* remote-high-speed-log * remote-syslog * arcsight * splunk * management-port * ipfix \| Specifies the type of log destination. Once created, this parameter cannot be changed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a high-speed logging destination bigip_log_destination: name: foo type: remote-high-speed-log pool: my-ltm-pool provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a remote-syslog logging destination bigip_log_destination: name: foo type: remote-syslog syslog_format: rfc5424 forward_to: my-destination provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address string \| changed \| The new Address value. Sample: 1.2.3.2 \| \| distribution string \| changed \| The new Distribution Method value. Sample: balanced \| \| forward\_to string \| changed \| The new Forward To value. Sample: /Common/dest1 \| \| pool string \| changed \| The new Pool value. Sample: /Common/pool1 \| \| port integer \| changed \| The new Port value. Sample: 2020 \| \| protocol string \| changed \| The new Protocol value. Sample: tcp \| \| server\_ssl\_profile string \| changed \| The new Server SSL Profile value. Sample: /Common/serverssl \| \| syslog\_format string \| changed \| The new Syslog format value. Sample: syslog \| \| template\_delete\_delay integer \| changed \| The new Template Delete Delay value. Sample: 20 \| \| template\_retransmit\_interval integer \| changed \| The new Template Retransmit Interval value. Sample: 200 \| \| transport\_profile string \| changed \| The new Transport Profile value. Sample: /Common/tcp \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_routedomain – Manage route domains on a BIG-IP f5networks.f5\_modules.bigip\_routedomain – Manage route domains on a BIG-IP ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_routedomain`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage route domains on a BIG-IP system. A route domain is a BIG-IP configuration object that isolates network traffic for a particular application on the network. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bwc\_policy string \| \| The bandwidth controller for the route domain. \| \| connection\_limit integer \| \| The maximum number of concurrent connections allowed for the route domain. Setting this to `0` turns off connection limits. \| \| description string \| \| Specifies descriptive text that identifies the route domain. \| \| flow\_eviction\_policy string \| \| The eviction policy to use with this route domain. Apply an eviction policy to provide customized responses to flow overflows and slow flows on the route domain. \| \| fw\_enforced\_policy string \| \| Specifies an AFM policy to be attached to route domain. To remove attached AFM policy use `""` or `none` as values. \| \| id integer \| \| The unique identifying integer representing the route domain. This field is required when creating a new route domain. In version 2.5, this value is no longer used to reference a route domain when making modifications to it (for instance during update and delete operations). Instead, the `name` parameter is used. In version 2.6, the `name` value will become a required parameter. \| \| name string \| \| The name of the route domain. \| \| parent string \| \| Specifies the route domain the system searches when it cannot find a route in the configured domain. \| \| partition string \| Default:"Common" \| Partition on which you want to create the route domain. Partitions cannot be updated once they are created. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| routing\_protocol list / elements=string \| Choices:* none * BFD * BGP * IS-IS * OSPFv2 * OSPFv3 * PIM * RIP * RIPng \| Dynamic routing protocols for the system to use in the route domain. \| \| service\_policy string \| \| Service policy to associate with the route domain. \| \| state string \| Choices:* present ← * absent \| Whether the route domain should exist or not. \| \| strict boolean \| Choices:* no * yes \| Specifies whether the system enforces cross-routing restrictions or not. \| \| vlans list / elements=string \| \| VLANs for the system to use in the route domain. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a route domain bigip_routedomain: name: foo id: 1234 state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Set VLANs on the route domain bigip_routedomain: name: bar state: present vlans: - net1 - foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| bwc\_policy string \| changed \| The new bandwidth controller. Sample: /Common/foo \| \| connection\_limit integer \| changed \| The new connection limit for the route domain. Sample: 100 \| \| description string \| changed \| The description of the route domain. Sample: route domain foo \| \| flow\_eviction\_policy string \| changed \| The new eviction policy to use with this route domain. Sample: /Common/default-eviction-policy \| \| fw\_enforced\_policy string \| changed \| Specifies the AFM policy to be attached to route domain. Sample: /Common/afm-blocking-policy \| \| id integer \| changed \| The ID of the route domain that was changed. Sample: 2 \| \| parent integer \| changed \| The new parent route domain. \| \| routing\_protocol list / elements=string \| changed \| List of routing protocols applied to the route domain. Sample: ['bfd', 'bgp'] \| \| service\_policy string \| changed \| The new service policy to use with this route domain. Sample: /Common-my-service-policy \| \| strict string \| changed \| The new strict isolation setting. Sample: enabled \| \| vlans list / elements=string \| changed \| List of new VLANs to which the route domain is applied. Sample: ['/Common/http-tunnel', '/Common/socks-tunnel'] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_monitor_tcp_echo – Manages F5 BIG-IP LTM TCP echo monitors f5networks.f5\_modules.bigip\_monitor\_tcp\_echo – Manages F5 BIG-IP LTM TCP echo monitors ========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_tcp_echo`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM TCP echo monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value is 5. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/tcp\_echo" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `tcp_echo` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of `0` will cause a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, the default value is be `0`. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this to any number, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value is 16. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create TCP Echo Monitor bigip_monitor_tcp_echo: state: present ip: 10.10.10.10 name: my_tcp_monitor provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove TCP Echo Monitor bigip_monitor_tcp_echo: state: absent name: my_tcp_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval in which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: tcp \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_service_policy – Manages service policies on a BIG-IP. f5networks.f5\_modules.bigip\_service\_policy – Manages service policies on a BIG-IP. ===================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_service_policy`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Service policies allow you to configure timers and port misuse rules (if enabled) on a per rule or per context basis. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the service policy. \| \| name string / required \| \| Name of the service policy. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port\_misuse\_policy string \| \| The port misuse policy to attach to the service policy. Requires `afm` (Advanced Firewall Manager) be provisioned to use. If `afm` is not provisioned, this parameter is ignored. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| Whether the resource should exist or not. \| \| timer\_policy string \| \| The timer policy to attach to the service policy. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a service policy bigip_service_policy: name: foo timer_policy: timer1 port_misuse_policy: misuse1 timer_policy_enabled: yes port_misuse_policy_enabled: yes state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| New description of the resource. Sample: My service policy description \| \| port\_misuse\_policy string \| changed \| The new port misuse policy attached to the resource. Sample: /Common/misuse1 \| \| timer\_policy string \| changed \| The new timer policy attached to the resource. Sample: /Common/timer1 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_remote_user – Manages default settings for remote user accounts on a BIG-IP f5networks.f5\_modules.bigip\_remote\_user – Manages default settings for remote user accounts on a BIG-IP ========================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_remote_user`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages the default settings for remote user accounts on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| console\_access boolean \| Choices:* no * yes \| Enables or disables the default console access for all remote user accounts. The default system value is `disabled`. \| \| default\_partition string \| \| Specifies the default partition for all remote user accounts. The default system value is `all` for all partitions. \| \| default\_role string \| Choices:* acceleration-policy-editor * admin * application-editor * auditor * certificate-manager * firewall-manager * fraud-protection-manager * guest * irule-manager * manager * no-access * operator * resource-admin * user-manager * web-application-security-administrator * web-application-security-editor \| Specifies the default role for all remote user accounts. The default system value is `no-access`. \| \| description string \| \| User-defined description. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Modify default partition and console access bigip_remote_user: default_partition: Common console_access: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify default role, partition and console access bigip_remote_user: default_partition: Common default_role: manager console_access: yes description: "Changed new settings" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Revert to default settings bigip_remote_user: default_partition: all default_role: "no-access" console_access: no description: "" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| console\_access boolean \| changed \| The default console access for all remote user accounts. \| \| default\_partition string \| changed \| The default partition for all remote user accounts. Sample: Common \| \| default\_role string \| changed \| The default role for all remote user accounts. Sample: auditor \| \| description string \| changed \| The user-defined description. Sample: Foo is bar \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_policy – Manage general policy configuration on a BIG-IP f5networks.f5\_modules.bigip\_policy – Manage general policy configuration on a BIG-IP ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_policy`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages general policy configuration on a BIG-IP. This module is best used in conjunction with the `bigip_policy_rule` module. This module can handle general configuration, like setting the draft state of the policy, the description, and items unrelated to the policy rules themselves. It is also the first module that should be used when creating rules, as the `bigip_policy_rule` module requires a policy parameter. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description to attach to the policy. This parameter is only supported on versions of BIG-IP >= 12.1.0. On earlier versions it is simply ignored. \| \| name string / required \| \| The name of the policy to create. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rules list / elements=string \| \| Specifies a list of rules you want associated with this policy. The order of this list is the order they will be evaluated by BIG-IP. If the specified rules do not exist (for example when creating a new policy) they will be created. The `conditions` for a default rule are `all`. The `actions` for a default rule are `ignore`. The `bigip_policy_rule` module can be used to create and edit existing and new rules. \| \| state string \| Choices:* present ← * absent * draft \| When `state` is `present`, ensures the policy exists and is published. When `state` is `absent`, ensures the policy is removed, even if it is currently drafted. When `state` is `draft`, ensures the policy exists and is drafted. When modifying rules, it is required that policies first be in a draft. Drafting is only supported on versions of BIG-IP >= 12.1.0. On versions prior to that, specifying a `state` of `draft` will raise an error. \| \| strategy string \| Choices:* first * all * best \| Specifies the method to determine which actions get executed when there are multiple rules that match. When creating new policies, the default is `first`. This module does not allow you to specify the `best` strategy to use. It will choose the system default (`/Common/best-match`) instead. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create policy which is immediately published bigip_policy: name: Policy-Foo state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add a rule to the new policy - Immediately published bigip_policy_rule: policy: Policy-Foo name: ABC conditions: - type: http_uri path_starts_with: - /ABC - foo - bar path_ends_with: - baz actions: - forward: yes select: yes pool: pool-svrs provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add multiple rules to the new policy - Added in the order they are specified bigip_policy_rule: policy: Policy-Foo name: "{{ item.name }}" conditions: "{{ item.conditions }}" actions: "{{ item.actions }}" provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost loop: - name: rule1 actions: - type: forward pool: pool-svrs conditions: - type: http_uri path_starts_with: /euro - name: HomePage actions: - type: forward pool: pool-svrs conditions: - type: http_uri path_starts_with: /HomePage/ - name: Create policy specify default rules - Immediately published bigip_policy: name: Policy-Bar state: present rules: - rule1 - rule2 - rule3 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Create policy specify default rules - Left in a draft bigip_policy: name: Policy-Baz state: draft rules: - rule1 - rule2 - rule3 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed and success \| The new description of the policy. This value is only returned for BIG-IP devices >= 12.1.0. Sample: This is my description \| \| rules list / elements=string \| changed and success \| List of the rules, and their order, applied to the policy. Sample: ['/Common/rule1', '/Common/rule2'] \| \| strategy integer \| changed and success \| The new strategy set on the policy. Sample: first-match \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_vcmp_guest – Manages vCMP guests on a BIG-IP f5networks.f5\_modules.bigip\_vcmp\_guest – Manages vCMP guests on a BIG-IP =========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_vcmp_guest`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages vCMP (Virtual Clustered Multiprocessing) guests on a BIG-IP. This functionality only exists on actual hardware and must be enabled by provisioning `vcmp` with the `bigip_provision` module. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allowed\_slots list / elements=string \| \| Contains those slots to which the guest is allowed to be assigned. When the host determines which slots this guest should be assigned, only slots in this list are considered. This is a good way to force guests to be assigned only to particular slots, or, by configuring disjoint `allowed_slots` on two guests, that those guests are never assigned to the same slot. By default, this list includes every available slot in the cluster. This means the guest may be assigned to any slot by default. \| \| cores\_per\_slot integer \| \| Specifies the number of cores the system allocates to the guest. Each core represents a portion of CPU and memory. Therefore, the amount of memory allocated per core is directly tied to the amount of CPU. This amount of memory varies per hardware platform type. The number you can specify depends on the type of hardware you have. In the event of a reboot, the system persists the guest to the same slot on which it ran prior to the reboot. \| \| delete\_virtual\_disk boolean \| Choices:* no ← * yes \| When `state` is `absent`, the system additionally deletes the virtual disk associated with the vCMP guest. By default, this value is `no`. \| \| initial\_hotfix string \| \| Specifies the hotfix ISO image file which is applied on top of the base image. \| \| initial\_image string \| \| Specifies the base software release ISO image file for installing the TMOS hypervisor instance and any licensed BIG-IP modules onto the guest's virtual disk. When creating a new guest, this parameter is required. Ensure this image is present on the VCMP host and not only on the VCMP guest. Also, the file reference for this image should be the one present on the host and not on the guest. \| \| mgmt\_address string \| \| Specifies the IP address and subnet or subnet mask you use to access the guest when you want to manage a module running within the guest. This parameter is required if the `mgmt_network` parameter is `bridged`. When creating a new guest, if you do not specify a network or network mask, a default of `/24` (`255.255.255.0`) is used. \| \| mgmt\_network string \| Choices:* bridged * isolated * host only \| Specifies the method by which the management address is used in the vCMP guest. When `bridged`, specifies the guest can communicate with the vCMP host's management network. When `isolated`, specifies the guest is isolated from the vCMP host's management network. In this case, the only way a guest can communicate with the vCMP host is through the console port or through a self IP address on the guest that allows traffic through port 22. When `host only`, prevents the guest from installing images and hotfixes other than those provided by the hypervisor. If the guest setting is `isolated` or `host only`, the `mgmt_address` does not apply. For mode changing, changing `bridged` to `isolated` causes the vCMP host to remove all of the guest's management interfaces from its bridged management network. This immediately disconnects the guest's VMs from the physical management network. Changing `isolated` to `bridged` causes the vCMP host to dynamically add the guest's management interfaces to the bridged management network. This immediately connects all of the guest's VMs to the physical management network. Changing this property while the guest is in the `configured` or `provisioned` state has no immediate effect. \| \| mgmt\_route string \| \| Specifies the gateway address for the `mgmt_address`. If this value is not specified when creating a new guest, it is set to `none`. The value `none` can be used during an update to remove this value. \| \| min\_number\_of\_slots integer \| \| Specifies the minimum number of slots the guest must be assigned to in order to deploy. This field dictates the number of slots to which the guest must be assigned. At the end of any allocation attempt, if the guest is not assigned to at least this many slots, the attempt fails and the change that initiated it is reverted. A guest's `min_number_of_slots` value cannot be greater than its `number_of_slots`. \| \| name string / required \| \| The name of the vCMP guest to manage. \| \| number\_of\_slots integer \| \| Specifies the number of slots for the system to use when creating the guest. This value dictates how many cores a guest is allocated from each slot to which it is assigned. Possible values are dependent on the type of blades being used in this cluster. The default value depends on the type of blades being used in this cluster. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* configured * disabled * provisioned * present ← * absent \| The state of the vCMP guest on the system. Each state implies the actions of all states before it. When `configured`, guarantees the vCMP guest exists with the provided attributes. Additionally, ensures the vCMP guest is turned off. When `disabled`, behaves the same way as `configured`, it is just a more user-friendly name. When `provisioned`, ensures the guest is created and installed. This state does not start the guest; use `deployed` for that purpose. This state is one step beyond `present`, as `present` does not install the guest; only sets up the configuration for it to be installed. When `present`, ensures the guest is properly provisioned and starts the guest so that it is in a running state. When `absent`, removes the vCMP from the system. \| \| vlans list / elements=string \| \| VLANs the guest uses to communicate with other guests, the host, and with the external network. The available VLANs in the list are those that are currently configured on the vCMP host. The order of these VLANs is not important and is ignored. This module orders the VLANs automatically. Therefore, if you deliberately re-order them in subsequent tasks, this module does not register a change. \| Notes ----- Note * This module can take a lot of time to deploy vCMP guests. This is an intrinsic limitation of the vCMP system, because it is booting real VMs on the BIG-IP device. This boot time is very similar in length to the time it takes to boot VMs on any other virtualization platform; public or private. * When BIG-IP starts, the VMs are booted sequentially; not in parallel. This means it is not unusual for a vCMP host with many guests to take a long time (60+ minutes) to reboot and bring all the guests online. The BIG-IP chassis will be available before all vCMP guests are online. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a vCMP guest bigip_vcmp_guest: name: foo mgmt_network: bridge mgmt_address: 10.20.30.40/24 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a vCMP guest with specific VLANs bigip_vcmp_guest: name: foo mgmt_network: bridge mgmt_address: 10.20.30.40/24 vlans: - vlan1 - vlan2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove vCMP guest and disk bigip_vcmp_guest: name: guest1 state: absent delete_virtual_disk: yes provider: password: secret server: lb.mydomain.com user: admin register: result ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| vlans list / elements=string \| changed \| The VLANs assigned to the vCMP guest, in their full path format. Sample: ['/Common/vlan1', '/Common/vlan2'] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_message_routing_route – Manages static routes for routing message protocol messages f5networks.f5\_modules.bigip\_message\_routing\_route – Manages static routes for routing message protocol messages =================================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_message_routing_route`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages static routes for routing message protocol messages. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The user-defined description of the static route. \| \| dst\_address string \| \| Specifies the destination address of the route. Setting the attribute to an empty string will create a wildcard matching all message destination-addresses, which is the default when creating a new route. \| \| name string / required \| \| Specifies the name of the static route. \| \| partition string \| Default:"Common" \| Device partition to create route object on. \| \| peer\_selection\_mode string \| Choices:* ratio * sequential \| Specifies the method to use when selecting a peer from the provided list of `peers`. \| \| peers list / elements=string \| \| Specifies a list of ltm messagerouting-peer objects. The specified peer must be on the same partition as the route. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| src\_address string \| \| Specifies the source address of the route. Setting the attribute to an empty string will create a wildcard matching all message source-addresses, which is the default when creating a new route. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the route exists. When `absent`, ensures the route is removed. \| \| type string \| Choices:* generic ← \| Parameter used to specify the type of the route to manage. Default setting is `generic` with more options coming. \| Notes ----- Note * Requires BIG-IP >= 14.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a simple generic route bigip_message_routing_route: name: foobar provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify a generic route bigip_message_routing_route: name: foobar peers: - peer1 - peer2 peer_selection_mode: ratio src_address: annoying_user dst_address: blackhole provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove a generic bigip_message_routing_route: name: foobar state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The user-defined description of the route. Sample: Some description \| \| dst\_address string \| changed \| The destination address of the route. Sample: blackhole \| \| peer\_selection\_mode string \| changed \| The method to use when selecting a peer. Sample: ratio \| \| peers list / elements=string \| changed \| The list of ltm messagerouting-peer object. Sample: ['/Common/peer1', '/Common/peer2'] \| \| src\_address string \| changed \| The source address of the route. Sample: annyoing\_user \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_sys_daemon_log_tmm – Manage BIG-IP tmm daemon log settings f5networks.f5\_modules.bigip\_sys\_daemon\_log\_tmm – Manage BIG-IP tmm daemon log settings =========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_sys_daemon_log_tmm`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP tmm log settings. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| arp\_log\_level string \| Choices:* debug * error * informational * notice * warning \| Specifies the lowest level of ARP messages from the tmm daemon to include in the system log. \| \| http\_compression\_log\_level string \| Choices:* debug * error * informational * notice * warning \| Specifies the lowest level of HTTP compression messages from the tmm daemon to include in the system log. \| \| http\_log\_level string \| Choices:* debug * error * informational * notice * warning \| Specifies the lowest level of HTTP messages from the tmm daemon to include in the system log. \| \| ip\_log\_level string \| Choices:* debug * informational * notice * warning \| Specifies the lowest level of IP address messages from the tmm daemon to include in the system log. \| \| irule\_log\_level string \| Choices:* debug * error * informational * notice * warning \| Specifies the lowest level of iRule messages from the tmm daemon to include in the system log. \| \| layer4\_log\_level string \| Choices:* debug * informational * notice \| Specifies the lowest level of Layer 4 messages from the tmm daemon to include in the system log. \| \| net\_log\_level string \| Choices:* critical * debug * error * informational * notice * warning \| Specifies the lowest level of network messages from the tmm daemon to include in the system log. \| \| os\_log\_level string \| Choices:* alert * critical * debug * emergency * error * informational * notice * warning \| Specifies the lowest level of operating system messages from the tmm daemon to include in the system log. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| pva\_log\_level string \| Choices:* debug * informational * notice \| Specifies the lowest level of PVA messages from the tmm daemon to include in the system log. \| \| ssl\_log\_level string \| Choices:* alert * critical * debug * emergency * error * informational * notice * warning \| Specifies the lowest level of SSL messages from the tmm daemon to include in the system log. \| \| state string \| Choices:* present ← \| The state of the log level on the system. When `present`, guarantees an existing log level is set to `value`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set SSL log level to debug bigip_sys_daemon_log_tmm: provider: password: secret server: lb.mydomain.com user: admin ssl_log_level: debug delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| arp\_log\_level string \| changed \| Lowest level of ARP messages from the tmm daemon to log. Sample: error \| \| http\_compression\_log\_level string \| changed \| Lowest level of HTTP compression messages from the tmm daemon to log. Sample: debug \| \| http\_log\_level string \| changed \| Lowest level of HTTP messages from the tmm daemon to log. Sample: notice \| \| ip\_log\_level string \| changed \| Lowest level of IP address messages from the tmm daemon to log. Sample: warning \| \| irule\_log\_level string \| changed \| Lowest level of iRule messages from the tmm daemon to log. Sample: error \| \| layer4\_log\_level string \| changed \| Lowest level of Layer 4 messages from the tmm daemon to log. Sample: notice \| \| net\_log\_level string \| changed \| Lowest level of network messages from the tmm daemon to log. Sample: critical \| \| os\_log\_level string \| changed \| Lowest level of operating system messages from the tmm daemon to log. Sample: critical \| \| pva\_log\_level string \| changed \| Lowest level of PVA messages from the tmm daemon to log. Sample: debug \| \| ssl\_log\_level string \| changed \| Lowest level of SSL messages from the tmm daemon to log. Sample: critical \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_asm_policy_signature_set – Manages Signature Sets on an ASM policy f5networks.f5\_modules.bigip\_asm\_policy\_signature\_set – Manages Signature Sets on an ASM policy =================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_asm_policy_signature_set`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages Signature Sets on an ASM policy. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| alarm boolean \| Choices:* no * yes \| Specifies if the security policy logs the request data in the Statistics screen when a request matches a signature that is included in the signature set. \| \| block boolean \| Choices:* no * yes \| Effective when the security policy enforcement mode is Blocking. Determines how the system treats requests that match a signature included in the signature set. When `yes`, the system blocks all requests that match a signature, and provides the client with a support ID number. When `no`, the system accepts those requests. \| \| learn boolean \| Choices:* no * yes \| Specifies if the security policy learns all requests that match a signature that is included in the signature set. \| \| name string / required \| \| Specifies the name of the signature sets to apply on, or remove from, the ASM policy. Apart from built-in signature sets that ship with the device, you can create and use custom signature sets. When `All Response Signatures`, configures all signatures in the attack signature pool that can review responses. When `All Signatures`, configures all attack signatures in the attack signature pool. When `Apache Struts Signatures`, configures signatures that target attacks against the Apache Struts web servers. Only available in version 13.x and later. When `Apache Tomcat Signatures`, configures signatures that target attacks against the Apache Tomcat web servers. Only available in version 13.x and later. When `Cisco Signatures`, configures signatures that target attacks against Cisco systems. Only available in version 13.x and later. When `Command Execution Signatures`, configures signatures involving attacks perpetrated by executing commands. When `Cross Site Scripting Signatures`, configures signatures that target attacks caused by cross-site scripting techniques. When `Directory Indexing Signatures`, configures signatures targeting attacks that browse directory listings. When `Generic Detection Signatures`, configures signatures targeting well-known or common web and application attacks. When `HTTP Response Splitting Signatures`, configures signatures targeting attacks that take advantage of responses for which input values have not been sanitized. When `High Accuracy Detection Evasion Signatures`, configures signatures with a high level of accuracy that produce few false positives when identifying evasion attacks. Only available in version 13.x and later. When `High Accuracy Signatures`, configures signatures with a high level of accuracy that produce few false positives when identifying evasion attacks. When `IIS and Windows Signatures`, configures signatures that target attacks against Microsoft IIS and Windows-based systems. Only available in version 13.x and later. When `Information Leakage Signatures`, configures signatures targeting attacks that are looking for system data or debugging information that shows where the system is vulnerable to attack. When `Java Servlets/JSP Signatures`, configures signatures that target attacks against Java Servlets and Java Server Pages (JSP) based applications. Only available in version 13.x and later. When `Low Accuracy Signatures`, configures signatures that may result in more false positives when identifying attacks. When `Medium Accuracy Signatures`, configures signatures with a medium level of accuracy when identifying attacks. When `OS Command Injection Signatures`, configures signatures targeting attacks that attempt to run system level commands through a vulnerable application. When `OWA Signatures`, configures signatures that target attacks against the Microsoft Outlook Web Access (OWA) application. When `Other Application Attacks Signatures`, configures signatures targeting miscellaneous attacks, including session fixation, local file access, injection attempts, header tampering and so on, affecting many applications. When `Path Traversal Signatures`, configures signatures targeting attacks that attempt to access files and directories that are stored outside the web root folder. When `Predictable Resource Location Signatures`, configures signatures targeting attacks that attempt to uncover hidden website content and functionality by forceful browsing, or by directory and file enumeration. When `Remote File Include Signatures`, configures signatures targeting attacks that attempt to exploit a remote file include vulnerability that could enable a remote attacker to execute arbitrary commands on the server hosting the application. When `SQL Injection Signatures`, configures signatures targeting attacks that attempt to insert (inject) a SQL query using the input data from a client to an application. When `Server Side Code Injection Signatures`, configures signatures targeting code injection attacks on the server side. When `WebSphere signatures`, configures signatures targeting attacks on many computing platforms that are integrated using WebSphere, including general database, Microsoft Windows, IIS, Microsoft SQL Server, Apache, Oracle, Unix/Linux, IBM DB2, PostgreSQL, and XML. When `XPath Injection Signatures`, configures signatures targeting attacks that attempt to gain access to data structures or bypass permissions when a web site uses user-supplied information to construct XPath queries for XML data. \| \| partition string \| Default:"Common" \| This parameter is only used when identifying an ASM policy. \| \| policy\_name string / required \| \| Specifies the name of an existing ASM policy to add or remove signature sets to. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * This module is primarily used as a component of configuring an ASM policy in the Ansible Galaxy ASM Policy Role. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add Signature Set to ASM Policy bigip_asm_policy_signature_set: name: IIS and Windows Signatures policy_name: FooPolicy provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove Signature Set to ASM Policy bigip_asm_policy_signature_set: name: IIS and Windows Signatures policy_name: FooPolicy state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| alarm boolean \| changed \| Specifies whether the security policy logs the request data in the Statistics screen. Sample: True \| \| block boolean \| changed \| Determines how the system treats requests that match a signature included in the signature set. \| \| learn boolean \| changed \| Specifies if the policy learns all requests that match a signature that is included in the signature set. Sample: True \| \| name string \| changed \| The name of the Signature Set added/removed on an ASM policy. Sample: Cisco Signatures \| \| policy\_name string \| changed \| The name of the ASM policy. Sample: FooPolicy \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_cli_script – Manage CLI scripts on a BIG-IP f5networks.f5\_modules.bigip\_cli\_script – Manage CLI scripts on a BIG-IP ========================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_cli_script`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages CLI scripts on a BIG-IP. CLI scripts, otherwise known as tmshell scripts or TMSH scripts, allow you to create custom scripts that can run to manage objects within a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| content string \| \| The content of the script. This parameter is typically used in conjunction with Ansible's `file` or template lookup plugins. See the examples in this documentation. \| \| description string \| \| Description of the cli script. \| \| name string / required \| \| Specifies the name of the script. \| \| partition string \| Default:"Common" \| Device partition on which to manage resources. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the script exists. When `absent`, ensures the script is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a cli script from an existing file bigip_cli_script: name: foo content: "{{ lookup('file', '/absolute/path/to/cli/script.tcl') }}" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a cli script from a jinja template representing a cli script bigip_cli_script: name: foo content: "{{ lookup('template', '/absolute/path/to/cli/script.tcl') }}" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| param1 boolean \| changed \| The new param1 value of the resource. Sample: True \| \| param2 string \| changed \| The new param2 value of the resource. Sample: Foo is bar \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_snmp_community – Manages SNMP communities on a BIG-IP. f5networks.f5\_modules.bigip\_snmp\_community – Manages SNMP communities on a BIG-IP. ===================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_snmp_community`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Assists in managing Simple Network Management Protocol (SNMP) communities on a BIG-IP system. Different SNMP versions are supported by this module. Note the different parameters offered by this module, as different parameters work for different versions of SNMP. This is important if you are mixing versions `v2c` and `3`. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| access string \| Choices:* ro * rw * read-only * read-write \| Specifies the user's access level to the MIB. When creating a new community, if this parameter is not specified, the default is `ro`. When `ro`, specifies the user can view the MIB, but cannot modify the MIB. When `rw`, specifies the user can view and modify the MIB. \| \| community string \| \| Specifies the community string (password) for access to the MIB. This parameter is only relevant when `version` is `v1` or `v2c`. If `version` is something else, this parameter is ignored. \| \| ip\_version string \| Choices:* 4 * 6 \| Specifies whether the record applies to IPv4 or IPv6 addresses. When creating a new community, if this value is not specified, the default is `4`. This parameter is only relevant when `version` is `v1` or `v2c`. If `version` is something else, this parameter is ignored. \| \| name string \| \| Name that identifies the SNMP community. When `version` is `v1` or `v2c`, this parameter is required. The name `public` is a reserved name on the BIG-IP. This module handles that name differently than others. Functionally, you should not see a difference. \| \| oid string \| \| Specifies the object identifier (OID) for the record. When `version` is `v3`, this parameter is required. When `version` is either `v1` or `v2c`, if this value is specified, then `source` must not be set to `all`. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port integer \| \| Specifies the port for the trap destination. This parameter is only relevant when `version` is `v1` or `v2c`. If `version` is something else, this parameter is ignored. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| snmp\_auth\_password string \| \| Specifies the password for the user. When creating a new SNMP `v3` community, this parameter is required. This value must be at least 8 characters long. \| \| snmp\_auth\_protocol string \| Choices:* md5 * sha * none \| Specifies the authentication method for the user. When `md5`, specifies the system uses the MD5 algorithm to authenticate the user. When `sha`, specifies the secure hash algorithm (SHA) to authenticate the user. When `none`, specifies the user does not require authentication. When creating a new SNMP `v3` community, if this parameter is not specified, the default is `sha`. \| \| snmp\_privacy\_password string \| \| Specifies the password for the user. When creating a new SNMP `v3` community, this parameter is required. This value must be at least 8 characters long. \| \| snmp\_privacy\_protocol string \| Choices:* aes * des * none \| Specifies the encryption protocol. When `aes`, specifies the system encrypts the user information using AES (Advanced Encryption Standard). When `des`, specifies the system encrypts the user information using DES (Data Encryption Standard). When `none`, specifies the system does not encrypt the user information. When creating a new SNMP `v3` community, if this parameter is not specified, the default is `aes`. \| \| snmp\_username string \| \| Specifies the name of the user for whom you want to grant access to the SNMP v3 MIB. This parameter is only relevant when `version` is `v3`. If `version` is something else, this parameter is ignored. When creating a new SNMP `v3` community, this parameter is required. This parameter cannot be changed once it has been set. \| \| source string \| \| Specifies the source address for access to the MIB. This parameter can accept a value of `all`. If this parameter is not specified, the value is `all`. This parameter is only relevant when `version` is `v1` or `v2c`. If `version` is something else, this parameter is ignored. If `source` is set to `all`, it is not possible to specify an `oid`. This will raise an error. You should provide this parameter when `state` is `absent`, so the correct community is removed. To remove the `public` SNMP community that comes with a BIG-IP, this parameter should be `default`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the address list and entries exists. When `absent`, ensures the address list is removed. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` allows users to update passwords. `on_create` only sets the password for newly created resources. \| \| version string \| Choices:* v1 * v2c ← * v3 \| Specifies to which SNMP version the trap destination applies. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an SMNP v2c read-only community bigip_snmp_community: name: foo version: v2c source: all oid: .1 access: ro provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create an SMNP v3 read-write community bigip_snmp_community: name: foo version: v3 snmp_username: foo snmp_auth_protocol: sha snmp_auth_password: secret snmp_privacy_protocol: aes snmp_privacy_password: secret oid: .1 access: rw provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove the default 'public' SNMP community bigip_snmp_community: name: public source: default state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| access string \| changed \| The new access level for the MIB. Sample: ro \| \| community string \| changed \| The new community value. Sample: community1 \| \| ip\_version string \| changed \| The new IP version value. Sample: 0.1 \| \| oid string \| changed \| The new OID value. Sample: 0.1 \| \| snmp\_auth\_password string \| changed \| The new password of the given snmp\_username. Sample: secret1 \| \| snmp\_auth\_protocol string \| changed \| The new SNMP auth protocol. Sample: sha \| \| snmp\_privacy\_password string \| changed \| The new password of the given snmp\_username. Sample: secret2 \| \| snmp\_privacy\_protocol string \| changed \| The new SNMP privacy protocol. Sample: aes \| \| snmp\_username string \| changed \| The new SNMP username. Sample: user1 \| \| source string \| changed \| The new source address to access the MIB. Sample: 1.1.1.1 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_traffic_selector – Manage IPSec Traffic Selectors on BIG-IP f5networks.f5\_modules.bigip\_traffic\_selector – Manage IPSec Traffic Selectors on BIG-IP ========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_traffic_selector`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage IPSec Traffic Selectors on BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the traffic selector. \| \| destination\_address string \| \| Specifies the host or network IP address to which the application traffic is destined. When creating a new traffic selector, this parameter is required. \| \| ipsec\_policy string \| \| Specifies the IPsec policy that tells the BIG-IP system how to handle the packets. When creating a new traffic selector, if this parameter is not specified, the default is `default-ipsec-policy`. \| \| name string / required \| \| Specifies the name of the traffic selector. \| \| order integer \| \| Specifies the order in which traffic is matched, if traffic can be matched to multiple traffic selectors. Traffic is matched to the traffic selector with the highest priority (lowest order number). When creating a new traffic selector, if this parameter is not specified, the default is `last`. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| source\_address string \| \| Specifies the host or network IP address from which the application traffic originates. When creating a new traffic selector, this parameter is required. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a traffic selector bigip_traffic_selector: name: selector1 destination_address: 1.1.1.1 ipsec_policy: policy1 order: 1 source_address: 2.2.2.2 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| destination\_address string \| changed \| The new Destination IP Address. Sample: 1.2.3.4/32 \| \| ipsec\_policy string \| changed \| The new IPSec policy. Sample: /Common/policy1 \| \| order integer \| changed \| The new sort order. Sample: 1 \| \| source\_address string \| changed \| The new Source IP address. Sample: 2.3.4.5/32 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_profile_tcp – Manage TCP profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_tcp – Manage TCP profiles on a BIG-IP ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_tcp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage TCP profiles on a BIG-IP system. There are many TCP profiles, each with their own adjustments to the standard `tcp` profile. Users of this module should be aware that many of the available options have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| delayed\_acks boolean \| Choices:* no * yes \| When `yes`, the system sends fewer than one ACK segment per data segment received. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| early\_retransmit boolean \| Choices:* no * yes \| When `yes`, the system uses early fast retransmits to reduce the recovery time for connections that are receive-buffer or user-data limited. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| idle\_timeout string \| \| Specifies the length of time a connection is idle (has no traffic) before the connection is eligible for deletion. When creating a new profile, if this parameter is not specified, the remote device will choose a default value appropriate for the profile, based on its `parent` profile. When a number is specified, indicates the number of seconds the TCP connection can remain idle before the system deletes it. When `0`, or `indefinite`, specifies the system does not delete TCP connections regardless of how long they remain idle. \| \| initial\_congestion\_window\_size integer \| \| Specifies the initial congestion window size for connections to this destination. The actual window size is this value multiplied by the MSS for the same connection. When set to `0`, the system uses the values specified in RFC2414. The valid value range is 0 - 16 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| initial\_receive\_window\_size integer \| \| Specifies the initial receive window size for connections to this destination. The actual window size is this value multiplied by the MSS for the same connection. When set to `0`, the system uses the Slow Start value. The valid value range is 0 - 16 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| ip\_tos\_to\_client string \| \| Specifies the L3 Type of Service level the system inserts in TCP packets destined for clients. When `pass-through`, the IP ToS setting remains unchanged. When `mimic`, the system sets the ToS level of outgoing packets to the same ToS level of the most-recently received incoming packet. When set as a number, the number indicates the IP ToS setting the system inserts in the IP packet header. Valid number range is 0 - 255 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| nagle string \| Choices:* auto * enabled * disabled \| When `enabled` the system applies Nagle's algorithm to reduce the number of short segments on the network. When `auto`, the use of Nagle's algorithm is decided based on network conditions. For interactive protocols such as Telnet, rlogin, or SSH, F5 recommends disabling this setting on high-latency networks, to improve application responsiveness. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| name string / required \| \| Specifies the name of the profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `tcp` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| proxy\_options boolean \| Choices:* no * yes \| When `yes`, the system advertises an option, such as a time-stamp, to the server only if it was negotiated with the client. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| syn\_rto\_base integer \| \| Specifies the initial RTO `Retransmission TimeOut` base multiplier for SYN retransmission, in `milliseconds`. This value is modified by the exponential backoff table to select the interval for subsequent retransmissions. The valid value range is 0 - 5000 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| time\_wait\_recycle boolean \| Choices:* no * yes \| Specifies connections in a TIME-WAIT state are reused if a SYN packet (indicating a request for a new connection) is received. When `no`, connections in a TIME-WAIT state remain unused for a specified length of time. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| time\_wait\_timeout string added in 1.3.0 of f5networks.f5\_modules \| \| Specifies the number of milliseconds a connection is in the TIME-WAIT state before closing. When `immediate`, the system closes the connection immediately after the connection enters the TIME-WAIT state. When `indefinite` or `0`, the system does not close TCP connections regardless of how long they remain in the TIME-WAIT state. The valid number range is from 0 to 600000 milliseconds. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a TCP profile bigip_profile_tcp: name: foo parent: f5-tcp-progressive time_wait_recycle: no idle_timeout: 300 state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| delayed\_acks boolean \| changed \| Specifies if the system sends fewer than one ACK segment per data segment received. Sample: True \| \| early\_retransmit boolean \| changed \| Specifies the use of early fast retransmits. Sample: True \| \| idle\_timeout integer \| changed \| The new idle timeout of the resource. Sample: 100 \| \| initial\_congestion\_window\_size integer \| changed \| Specifies the initial congestion window size for connections to this destination. Sample: 5 \| \| initial\_receive\_window\_size integer \| changed \| Specifies the initial receive window size for connections to this destination. Sample: 10 \| \| ip\_tos\_to\_client string \| changed \| Specifies the L3 Type of Service level that the system inserts in TCP packets destined for clients. Sample: mimic \| \| nagle string \| changed \| Specifies the use of Nagle's algorithm. Sample: auto \| \| parent string \| changed \| The new parent of the resource. Sample: f5-tcp-optimized \| \| proxy\_options boolean \| changed \| Specifies if the system advertises negotiated options to the server. \| \| syn\_rto\_base integer \| changed \| Specifies the initial Retransmission TimeOut base multiplier for SYN retransmission. Sample: 2000 \| \| time\_wait\_recycle boolean \| changed \| Reuse connections in TIME-WAIT state. Sample: True \| \| time\_wait\_timeout string \| changed \| Specifies the number of milliseconds that a connection is in the TIME-WAIT state before closing. Sample: immediate \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_firewall_address_list – Manage address lists on BIG-IP AFM f5networks.f5\_modules.bigip\_firewall\_address\_list – Manage address lists on BIG-IP AFM ========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_address_list`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages the AFM (Advanced Firewall Manager) address lists on a BIG-IP. This module can be used to add and remove address list entries. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address\_lists list / elements=string \| \| Simple list of existing address lists to add to this list. Address lists can be specified in either their fully qualified name (/Common/foo) or their short name (foo). If a short name is used, the `partition` argument will automatically be prepended to the short name. \| \| address\_ranges list / elements=string \| \| A list of address ranges where the range starts with a port number, is followed by a dash (-), and then a second number. If the first address is greater than the second number, the numbers will be reversed so-as to be properly formatted. For example, `2.2.2.2-1.1.1`. would become `1.1.1.1-2.2.2.2`. \| \| addresses list / elements=string \| \| Individual addresses you want to add to the list. These addresses differ from ranges and lists of lists, such as what can be used in `address_ranges` and `address_lists` respectively. This list can also include networks that have CIDR notation. \| \| description string \| \| Description of the address list. \| \| fqdns list / elements=string \| \| A list of fully qualified domain names (FQDNs). An FQDN has at least one decimal point in it, separating the host from the domain. To add FQDNs to a list requires that a global FQDN resolver is configured. This must either be done via `bigip_command`, or in the GUI of the BIG-IP. If using `bigip_command`, you can do this with `tmsh modify security firewall global-fqdn-policy FOO` where `FOO` is a DNS resolver configured at `tmsh create net dns-resolver FOO`. \| \| geo\_locations list / elements=dictionary \| \| List of geolocations specified by their `country` and `region`. \| \| \| country string / required \| Choices:* Any valid 2 character ISO country code. * Any valid country name. \| The country name, or code, of the geolocation to use. In addition to the country full names, you may also specify their abbreviated form, such as `US` instead of `United States`. Valid country codes can be found here https://countrycode.org/. \| \| \| region string \| \| Region name of the country to use. \| \| name string / required \| \| Specifies the name of the address list. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the address list and entries exists. When `absent`, ensures the address list is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an address list bigip_firewall_address_list: name: foo addresses: - 3.3.3.3 - 4.4.4.4 - 5.5.5.5 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address\_lists list / elements=string \| changed \| The new list of address list names applied to the address list. Sample: ['/Common/list1', '/Common/list2'] \| \| address\_ranges list / elements=string \| changed \| The new list of address ranges applied to the address list. Sample: ['1.1.1.1-2.2.2.2', '3.3.3.3-4.4.4.4'] \| \| addresses list / elements=string \| changed \| The new list of addresses applied to the address list. Sample: ['1.1.1.1', '2.2.2.2'] \| \| description string \| changed \| The new description of the address list. Sample: My address list \| \| fqdns list / elements=string \| changed \| The new list of FQDN names applied to the address list. Sample: ['google.com', 'mit.edu'] \| \| geo\_locations complex \| changed \| The new list of geolocations applied to the address list. \| \| \| country string \| changed \| Country of the geolocation. Sample: US \| \| \| region string \| changed \| Region of the geolocation. Sample: California \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_ike_peer – Manage IPSec IKE Peer configuration on BIG-IP f5networks.f5\_modules.bigip\_ike\_peer – Manage IPSec IKE Peer configuration on BIG-IP ======================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_ike_peer`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage IPSec IKE Peer configuration on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the IKE peer. \| \| name string / required \| \| Specifies the name of the IKE peer. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| phase1\_auth\_method string \| Choices:* pre-shared-key * rsa-signature \| Specifies the authentication method for phase 1 negotiation. When creating a new IKE peer, if this value is not specified, the default is `rsa-signature`. \| \| phase1\_cert string \| \| Specifies the digital certificate to use for the RSA signature. When creating a new IKE peer, if this value is not specified, and `phase1_auth_method` is `rsa-signature`, the default is `default.crt`. This parameter is invalid when `phase1_auth_method` is `pre-shared-key`. \| \| phase1\_encryption\_algorithm string \| Choices:* 3des * des * blowfish * cast128 * aes128 * aes192 * aes256 * camellia \| Specifies the algorithm to use for IKE encryption. IKE `version` `v2` does not support `blowfish`, `camellia`, or `cast128`. \| \| phase1\_hash\_algorithm string \| Choices:* sha1 * md5 * sha256 * sha384 * sha512 \| Specifies the algorithm to use for IKE authentication. \| \| phase1\_key string \| \| Specifies the public key the digital certificate contains. When creating a new IKE peer, if this value is not specified, and `phase1_auth_method` is `rsa-signature`, the default is `default.key`. This parameter is invalid when `phase1_auth_method` is `pre-shared-key`. \| \| phase1\_lifetime integer added in 1.1.0 of f5networks.f5\_modules \| \| Defines the lifetime in minutes of an IKE SA which will be proposed in the phase 1 negotiations. The accepted value range is `1 - 4294967295` minutes. When creating a new IKE peer, if this value is not specified, the default value set by the system is `1440` minutes. \| \| phase1\_perfect\_forward\_secrecy string \| Choices:* ecp256 * ecp384 * ecp521 * modp768 * modp1024 * modp1536 * modp2048 * modp3072 * modp4096 * modp6144 * modp8192 \| Specifies the Diffie-Hellman group to use for IKE Phase 1 and Phase 2 negotiations. \| \| phase1\_verify\_peer\_cert boolean \| Choices:* no * yes \| In IKEv2, specifies whether the certificate sent by the IKE peer is verified using the Trusted Certificate Authorities, a CRL, and/or a peer certificate. In IKEv1, specifies whether the identifier sent by the peer is verified with the credentials in the certificate, in the following manner - ASN1DN; specifies that the entire certificate subject name is compared with the identifier. Address, FQDN, or User FQDN; specifies that the certificate's subjectAltName is compared with the identifier. If the two do not match, the negotiation fails. When creating a new IKE peer, if this value is not specified, and `phase1_auth_method` is `rsa-signature`, the default is `no`. This parameter is invalid when `phase1_auth_method` is `pre-shared-key`. \| \| presented\_id\_type string \| Choices:* address * asn1dn * fqdn * keyid-tag * user-fqdn * override \| Specifies the identifier type the local system uses to identify itself to the peer during IKE Phase 1 negotiations. \| \| presented\_id\_value string \| \| Specifies a value for the identity when using a `presented_id_type` of `override`. This is a required value when `version` includes (Cv2). \| \| preshared\_key string \| \| Specifies a string the IKE peers share for authenticating each other. This parameter is only relevant when `phase1_auth_method` is `pre-shared-key`. This parameter is invalid when `phase1_auth_method` is `rsa-signature`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| remote\_address string \| \| Displays the IP address of the BIG-IP system that is remote to the system you are configuring. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will allow updating passwords if the user chooses to do so. `on_create` will only set the password for newly created IKE peers. \| \| verified\_id\_type string \| Choices:* address * asn1dn * fqdn * keyid-tag * user-fqdn * override \| Specifies the identifier type that the local system uses to identify the peer during IKE Phase 1 negotiation. This is a required value when `version` includes (Cv2). When `user-fqdn`, value of `verified_id_value` must be in the form of User @ DNS domain string. \| \| verified\_id\_value string \| \| Specifies a value for the identity when using a `verified_id_type` of `override`. This is a required value when `version` includes (Cv2). \| \| version list / elements=string \| Choices:* v1 * v2 \| Specifies which version of IKE is used. If the system you are configuring is the IPsec initiator, and you select both versions, the system tries using IKEv2 for negotiation. If the remote peer does not support IKEv2, the IPsec tunnel fails. To use IKEv1 in this case, you must deselect Version 2 and try again. If the system you are configuring is the IPsec responder, and you select both versions, the IPsec initiator system determines which IKE version to use. When creating a new IKE peer, this value is required. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create new IKE peer bigip_ike_peer: name: ike1 remote_address: 1.2.3.4 version: - v1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Change presented id type - keyid-tag bigip_ike_peer: name: ike1 presented_id_type: keyid-tag presented_id_value: key1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove IKE peer bigip_ike_peer: name: ike1 state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| phase1\_auth\_method string \| changed \| The new IKE Phase 1 Credentials Authentication Method value of the resource. Sample: rsa-signature \| \| phase1\_cert string \| changed \| The new IKE Phase 1 Certificate Credentials. Sample: /Common/cert1.crt \| \| phase1\_encryption\_algorithm string \| changed \| The new IKE Phase 1 Encryption Algorithm. Sample: 3des \| \| phase1\_hash\_algorithm string \| changed \| The new IKE Phase 1 Authentication Algorithm. Sample: sha256 \| \| phase1\_key string \| changed \| The new IKE Phase 1 Key Credentials. Sample: /Common/cert1.key \| \| phase1\_perfect\_forward\_secrecy string \| changed \| The new IKE Phase 1 Perfect Forward Secrecy. Sample: modp1024 \| \| phase1\_verify\_peer\_cert boolean \| changed \| The new IKE Phase 1 Key Verify Peer Certificate setting. Sample: True \| \| presented\_id\_type string \| changed \| The new Presented ID Type value of the resource. Sample: address \| \| presented\_id\_value string \| changed \| The new Presented ID Value setting for the Presented ID Type. Sample: 1.2.3.1 \| \| remote\_address string \| changed \| The new Remote Address value of the resource. Sample: 1.2.2.1 \| \| verified\_id\_type string \| changed \| The new Verified ID Type value of the resource. Sample: address \| \| verified\_id\_value string \| changed \| The new Verified ID Value setting for the Verified ID Type. Sample: 1.2.3.1 \| \| version list / elements=string \| changed \| The new list of IKE versions. Sample: ['v1', 'v2'] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigiq_utility_license – Manage utility licenses on a BIG-IQ f5networks.f5\_modules.bigiq\_utility\_license – Manage utility licenses on a BIG-IQ ==================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_utility_license`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages utility licenses on a BIG-IQ. Utility licenses are one form of license that BIG-IQ can distribute. These licenses, unlike regkey licenses, do not require a pool to be created before creation. Additionally, when assigning them, you assign by offering instead of key. Requirements ------------ The below requirements are needed on the host that executes this module. * BIG-IQ >= 5.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accept\_eula boolean \| Choices:* no * yes \| A key that signifies you accept the F5 EULA for this license. A copy of the EULA can be found here https://askf5.f5.com/csp/article/K12902 This is required when `state` is `present`. \| \| license\_key string / required \| \| The license key to install and activate. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* absent * present ← \| The state of the utility license on the system. When `present`, guarantees the license exists. When `absent`, removes the license from the system. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add a utility license to the system bigiq_utility_license: license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX accept_eula: yes state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove a utility license from the system bigiq_utility_license: license_key: XXXXX-XXXXX-XXXXX-XXXXX-XXXXX state: absent provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_device_connectivity – Manages device IP configuration settings for HA on a BIG-IP. f5networks.f5\_modules.bigip\_device\_connectivity – Manages device IP configuration settings for HA on a BIG-IP. ================================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_connectivity`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages device IP configuration settings for High Availability (HA) on a BIG-IP. Each BIG-IP device has synchronization and failover connectivity information (IP addresses) that you define as part of HA pairing or clustering. This module allows you to configure that information. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cluster\_mirroring string \| Choices:* between-clusters * within-cluster \| Specifies whether mirroring occurs within the same cluster or between different clusters on a multi-bladed system. This parameter is only supported on platforms that have multiple blades, such as Viprion hardware. It is not supported on Virtual Editions (VEs). \| \| config\_sync\_ip string \| \| Local IP address the system uses for ConfigSync operations. \| \| failover\_multicast boolean \| Choices:* no * yes \| When `yes`, ensures the Failover Multicast configuration is enabled and, if no further multicast configuration is provided, ensures that `multicast_interface`, `multicast_address` and `multicast_port` are the defaults specified in the description of each option. When `no`, ensures that Failover Multicast configuration is disabled. \| \| mirror\_primary\_address string \| \| Specifies the primary IP address for the system to use to mirror connections. \| \| mirror\_secondary\_address string \| \| Specifies the secondary IP address for the system to use to mirror connections. \| \| multicast\_address string \| \| IP address for the system to send multicast messages associated with failover. When `failover_multicast` is `yes` and this option is not provided, a default of `224.0.0.245` will be used. \| \| multicast\_interface string \| \| Interface over which the system sends multicast messages associated with failover. When `failover_multicast` is `yes` and this option is not provided, a default of `eth0` will be used. \| \| multicast\_port integer \| \| Port for the system to send multicast messages associated with failover. When `failover_multicast` is `yes` and this option is not provided, a default of `62960` will be used. This value must be between 0 and 65535. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| unicast\_failover list / elements=dictionary \| \| Addresses to use for failover operations. Options `address` and `port` are supported with dictionary structure, where `address` is the local IP address the system uses for failover operations. Port specifies the port the system uses for failover operations. If `port` is not specified, the default value `1026` will be used. If you are specifying the (recommended) management IP address, use 'management-ip' in the address field. When the value is set to empty list, the parameter value is removed from device. \| Notes ----- Note * This module is primarily used as a component of configuring HA pairs of BIG-IP devices. * Requires BIG-IP >= 12.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Configure device connectivity for standard HA pair bigip_device_connectivity: config_sync_ip: 10.1.30.1 mirror_primary_address: 10.1.30.1 unicast_failover: - address: management-ip - address: 10.1.30.1 provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Denotes if the F5 configuration was updated. \| \| cluster\_mirroring string \| changed \| The current cluster-mirroring setting. Sample: between-clusters \| \| config\_sync\_ip string \| changed \| The new value of the `config_sync_ip` setting. Sample: 10.1.1.1 \| \| failover\_multicast boolean \| changed \| Whether a failover multicast attribute has been changed or not. \| \| mirror\_primary\_address string \| changed \| The new value of the `mirror_primary_address` setting. Sample: 10.1.1.2 \| \| mirror\_secondary\_address string \| changed \| The new value of the `mirror_secondary_address` setting. Sample: 10.1.1.3 \| \| multicast\_address string \| changed \| The new value of the `multicast_address` setting. Sample: 224.0.0.245 \| \| multicast\_interface string \| changed \| The new value of the `multicast_interface` setting. Sample: eth0 \| \| multicast\_port integer \| changed \| The new value of the `multicast_port` setting. Sample: 1026 \| \| unicast\_failover list / elements=string \| changed \| The new value of the `unicast_failover` setting. Sample: [{'address': '10.1.1.2', 'port': 1026}] \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_virtual_address – Manage LTM virtual addresses on a BIG-IP f5networks.f5\_modules.bigip\_virtual\_address – Manage LTM virtual addresses on a BIG-IP ========================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_virtual_address`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage LTM virtual addresses on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| Specifies the virtual address. This value cannot be modified after it is set. If you never created a virtual address, but did create virtual servers, a virtual address for each virtual server was created automatically. The name of this virtual address is its IP address value. \| \| arp boolean \| Choices:* no * yes \| Specifies whether the system accepts ARP requests. When `no`, specifies the system does not accept ARP requests. When `yes`, the packets are dropped. Both ARP and ICMP Echo must be disabled in order for forwarding virtual servers using that virtual address to forward ICMP packets. When creating a new virtual address, if this parameter is not specified, the default value is `yes`. \| \| auto\_delete boolean \| Choices:* no * yes \| Specifies whether the system automatically deletes the virtual address with the deletion of the last associated virtual server. When `no`, specifies the system leaves the virtual address, even when all associated virtual servers have been deleted. When creating the virtual address, the default value is `yes`. \| \| availability\_calculation string \| Choices:* always * when\_all\_available * when\_any\_available \| Specifies which routes of the virtual address the system advertises. When `when_any_available`, advertises the route when any virtual server is available. When `when_all_available`, advertises the route when all virtual servers are available. When (always), always advertises the route regardless of the virtual servers available. aliases: advertise\_route \| \| connection\_limit integer \| \| Specifies the number of concurrent connections the system allows on this virtual address. \| \| icmp\_echo string \| Choices:* enabled * disabled * selective \| Specifies how the system sends responses to (ICMP) echo requests on a per-virtual address basis for enabling route advertisement. When `enabled`, the BIG-IP system intercepts ICMP echo request packets and responds to them directly. When `disabled`, the BIG-IP system passes ICMP echo requests through to the backend servers. When (selective), causes the BIG-IP system to internally enable or disable responses based on virtual server state; `when_any_available`, `when_all_available, or C(always`, regardless of the state of any virtual servers. \| \| name string \| \| Name of the virtual address. If this parameter is not provided, the system uses the value of `address`. \| \| netmask string \| \| Specifies the netmask of the provided virtual address. This value cannot be modified after it is set. When creating a new virtual address, if this parameter is not specified, the default value is `255.255.255.255` for IPv4 addresses and `ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff` for IPv6 addresses. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| route\_advertisement string \| Choices:* disabled * enabled * always * selective * any * all \| Specifies whether the system uses route advertisement for this virtual address. When disabled, the system does not advertise routes for this virtual address. The majority of these options are only supported on versions 13.0.0-HF1 or later. On versions prior than this, all choices expect `disabled` translate to `enabled`. When `always`, the BIG-IP system always advertises the route for the virtual address, regardless of availability status. This requires an `enabled` virtual address. When `enabled`, the BIG-IP system advertises the route for the available virtual address, based on the calculation method in the availability calculation. When `disabled`, the BIG-IP system does not advertise the route for the virtual address, regardless of the availability status. When `selective`, you can also selectively enable ICMP echo responses, which causes the BIG-IP system to internally enable or disable responses based on virtual server state. When `any`, the BIG-IP system advertises the route for the virtual address when any virtual server is available. When `all`, the BIG-IP system advertises the route for the virtual address when all virtual servers are available. \| \| route\_domain string \| \| The route domain of the `address` you want to use. This value cannot be modified after it is set. \| \| spanning boolean \| Choices:* no * yes \| Enables all BIG-IP systems in a device group to listen for and process traffic on the same virtual address. Spanning for a virtual address occurs when you enable the `spanning` option on a device, and then sync the virtual address to the other members of the device group. Spanning also relies on the upstream router to distribute application flows to the BIG-IP systems using ECMP routes. ECMP defines a route to the virtual address using distinct Floating self-IP addresses configured on each BIG-IP system. You must also configure MAC masquerade addresses and disable `arp` on the virtual address when Spanning is enabled. When creating a new virtual address, if this parameter is not specified, the default valus is `no`. \| \| state string \| Choices:* present ← * absent * enabled * disabled \| The virtual address state. If `absent`, the system makes an attempt to delete the virtual address. This will only succeed if this virtual address is not in use by a virtual server. `present` creates the virtual address and enables it. If `enabled`, enables the virtual address if it exists. If `disabled`, creates the virtual address if needed, and sets the state to `disabled`. \| \| traffic\_group string \| \| The traffic group for the virtual address. When creating a new address, if this value is not specified, the default is `/Common/traffic-group-1`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add virtual address bigip_virtual_address: state: present partition: Common address: 10.10.10.10 provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Enable route advertisement on the virtual address bigip_virtual_address: state: present address: 10.10.10.10 route_advertisement: any provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address integer \| created \| The address of the virtual address. Sample: 2345 \| \| arp boolean \| changed \| The new way the virtual address handles ARP requests. Sample: True \| \| auto\_delete boolean \| changed \| New setting for auto deleting virtual address. Sample: True \| \| availability\_calculation string \| changed \| Specifies which routes of the virtual address the system advertises. Sample: always \| \| connection\_limit integer \| changed \| The new connection limit of the virtual address. Sample: 1000 \| \| icmp\_echo string \| changed \| New ICMP echo setting applied to virtual address. Sample: disabled \| \| netmask integer \| created \| The netmask of the virtual address. Sample: 2345 \| \| spanning string \| changed \| Whether spanning is enabled or not. Sample: disabled \| \| state string \| changed \| The new state of the virtual address. Sample: disabled \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_firewall_log_profile – Manages AFM logging profiles configured in the system f5networks.f5\_modules.bigip\_firewall\_log\_profile – Manages AFM logging profiles configured in the system ============================================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_log_profile`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages AFM (Advanced Firewall Manager) logging profiles configured in the system along with basic information about each profile. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the log profile. \| \| dos\_protection dictionary \| \| Configures DoS related settings of the log profile. \| \| \| dns\_publisher string \| \| Specifies the name of the log publisher used for DNS DoS events. To specify the log\_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter. \| \| \| network\_publisher string \| \| Specifies the name of the log publisher used for DoS Network events. To specify the log\_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter. \| \| \| sip\_publisher string \| \| Specifies the name of the log publisher used for SIP DoS events. To specify the log\_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter. \| \| ip\_intelligence dictionary \| \| Configures IP Intelligence related settings of the log profile. \| \| \| log\_publisher string \| \| Specifies the name of the log publisher used for IP Intelligence events. To specify the log\_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred the from `partition` module parameter. \| \| \| log\_rtbh boolean \| Choices:* no * yes \| When `yes`, specifies remotely triggered blackholing events are logged. \| \| \| log\_shun boolean \| Choices:* no * yes \| When `yes`, specifies IP Intelligence shun list events are logged. This option can only be set on the `global-network` built-in profile. \| \| \| log\_translation\_fields boolean \| Choices:* no * yes \| This option is used to enable or disable the logging of translated (i.e server side) fields in IP Intelligence log messages. Translated fields include (but are not limited to) source address/port, destination address/port, IP protocol, route domain, and VLAN. \| \| \| rate\_limit string \| \| Defines a rate limit for all combined IP intelligence log messages per second. Beyond this rate limit, log messages are not logged until the threshold drops below the specified rate. To specify an indefinite rate, use the value `indefinite`. If specifying a numeric rate, the value must be between `1` and `4294967295`. \| \| name string / required \| \| Specifies the name of the log profile. \| \| partition string \| Default:"Common" \| Device partition to create log profile on. Parameter also used when specifying names for log publishers, unless log publisher names are in fullpath format. \| \| port\_misuse dictionary \| \| Port Misuse log configuration. \| \| \| log\_publisher string \| \| Specifies the name of the log publisher used for Port Misuse events. To specify the log\_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter. \| \| \| rate\_limit string \| \| Defines a rate limit for all combined port misuse log messages per second. Beyond this rate limit, log messages are not logged until the threshold drops below the specified rate. To specify an indefinite rate, use the value `indefinite`. If specifying a numeric rate, the value must be between `1` and `4294967295`. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the resource exists. When `state` is `absent`, ensures the resource is removed. Attempts to remove built-in system profiles are ignored and no change is returned. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a basic log profile with port misuse bigip_firewall_log_profile: name: barbaz port_misuse: rate_limit: 30000 log_publisher: local-db-pub provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Change ip_intelligence settings, publisher on different partition, remove port misuse bigip_firewall_log_profile: name: barbaz ip_intelligence: rate_limit: 400000 log_translation_fields: yes log_rtbh: yes log_publisher: "/foobar/non-local-db" port_misuse: log_publisher: "" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a log profile with dos protection, different partition bigip_firewall_log_profile: name: foobar partition: foobar dos_protection: dns_publisher: "/Common/local-db-pub" sip_publisher: "non-local-db" network_publisher: "/Common/local-db-pub" provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove log profile bigip_firewall_log_profile: name: barbaz partition: Common state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| New description of the AFM log profile. Sample: This is my description \| \| dos\_protection complex \| changed \| Log publishers used in DoS related settings of the log profile. Sample: hash/dictionary of values \| \| \| dns\_publisher string \| changed \| The name of the log publisher used for DNS DoS events. Sample: /Common/local-db-publisher \| \| \| network\_publisher string \| changed \| The name of the log publisher used for DoS Network events. Sample: /Common/local-db-publisher \| \| \| sip\_publisher string \| changed \| The name of the log publisher used for SIP DoS events. Sample: /Common/local-db-publisher \| \| ip\_intelligence complex \| changed \| IP Intelligence related settings of the log profile. Sample: hash/dictionary of values \| \| \| log\_publisher string \| changed \| The name of the log publisher used for IP Intelligence events. Sample: /Common/local-db-publisher \| \| \| log\_rtbh boolean \| changed \| Logging of remotely triggered blackholing events. Sample: True \| \| \| log\_shun boolean \| changed \| Logging of IP Intelligence shun list events. \| \| \| log\_translation\_fields boolean \| changed \| Logging of translated fields in IP Intelligence log messages. \| \| \| rate\_limit string \| changed \| The rate limit for all combined IP intelligence log messages per second. Sample: indefinite \| \| port\_misuse complex \| changed \| Port Misuse related settings of the log profile. Sample: hash/dictionary of values \| \| \| log\_publisher string \| changed \| The name of the log publisher used for Port Misuse events. Sample: /Common/local-db-publisher \| \| \| rate\_limit string \| changed \| The rate limit for all combined Port Misuse log messages per second. Sample: indefinite \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_apm_acl – Manage user-defined APM ACLs f5networks.f5\_modules.bigip\_apm\_acl – Manage user-defined APM ACLs ===================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_apm_acl`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage user-defined APM ACLs. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| acl\_order integer \| \| Specifies a number that indicates the order of this ACL relative to other ACLs. When not set, the device will always place the ACL after the last one created. The lower the number, the higher the ACL will be in the general order, with the lowest number `0` being the topmost one. Valid range of values is between `0` and `65535` inclusive. \| \| description string \| \| User created ACL description. \| \| entries list / elements=dictionary \| \| Access control entries that define the ACL matching and its respective behavior. The order in which the rules are placed as arguments to this parameter determines their order in the ACL, in other words changing the order of the same elements will cause a change on the unit. Changes in the number of rules will always trigger device change. This means user input will take precedence over what is on device. \| \| \| action string / required \| Choices:* allow * reject * discard * continue \| Specifies the action that the access control entry takes when a match for this access control entry is encountered. \| \| \| dst\_addr string \| \| Specifies the destination IP address for the access control entry. When set to `any` the ACL will match any destination address, `dst_mask` is ignored in this case. \| \| \| dst\_mask string \| \| Optional parameter that specifies the destination network mask for the access control entry. If not specified and `dst_addr` is not `any`, the `dst_addr` is deemed to be host address. \| \| \| dst\_port string \| \| Specifies the destination port for the access control entry. Can be set to `` to indicate all ports. Parameter is mutually exclusive with `dst_port_range`. \| \| \| dst\_port\_range* string \| \| Specifies the destination port range for the access control entry. Parameter is mutually exclusive with `dst_port_range`. To indicate all ports the `dst_port` parameter must be used and set to ``. \| \| \| host\_name* string \| \| This parameter applies to Layer 7 access control entries only. Specifies a host to which the access control entry applies. \| \| \| log string \| Choices:* none * packet \| Specifies the log level that is logged when actions of this type occur. When `none` it will log nothing, which is a default action. When `packet` it will log the matched packet. \| \| \| paths string \| \| This parameter applies to Layer 7 access control entries only. Specifies the path or paths to which the access control entry applies. \| \| \| protocol string \| Choices:* tcp * icmp * udp * all \| This parameter applies to Layer 4 access control entries only. Specifies the protocol: `tcp`, `udp`, `icmp` or `all` protocols, to which the access control entry applies. \| \| \| scheme string \| Choices:* http * https * any \| This parameter applies to Layer 7 access control entries only. Specifies the URI scheme: `http`, `https` or `any` on which the access control entry operates. \| \| \| src\_addr string \| \| Specifies the source IP address for the access control entry. When set to `any` the ACL will match any source address, `src_mask` is ignored in this case. \| \| \| src\_mask string \| \| Optional parameter that specifies the source network mask for the access control entry. If not specified and `src_addr` is not `any`, the `src_addr` is deemed to be host address. \| \| \| src\_port string \| \| Specifies the source port for the access control entry. Can be set to `` to indicate all ports. Parameter is mutually exclusive with `src_port_range`. \| \| \| src\_port\_range* string \| \| Specifies the source port range for the access control entry. Parameter is mutually exclusive with `src_port_range`. To indicate all ports the `src_port` parameter must be used and set to ``. \| \| name* string / required \| \| Specifies the name of the ACL to manage. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| path\_match\_case boolean \| Choices:* no * yes \| Specifies whether alphabetic case is considered when matching paths in an access control entry. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures that the ACL exists. When `state` is `absent`, ensures that the ACL is removed. \| \| type string \| Choices:* static * dynamic \| Specifies the type of ACL to create. Once the type is set it cannot be changed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a static ACL with L4 entries bigip_apm_acl: name: L4foo acl_order: 0 type: static entries: - action: allow dst_port: '80' dst_addr: '192.168.1.1' src_port: '443' src_addr: '10.10.10.0' src_mask: '255.255.255.128' protocol: tcp - action: reject dst_port: '' dst_addr: '192.168.1.1' src_port: '' src_addr: '10.10.10.0' src_mask: '255.255.255.128' protocol: tcp log: packet provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a static ACL with L7 entries bigip_apm_acl: name: L7foo acl_order: 1 type: static path_match_case: no entries: - action: allow host_name: 'foobar.com' paths: '/shopfront' scheme: https - action: reject host_name: 'internal_foobar.com' paths: '/admin' scheme: any log: packet provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Create a static ACL with L7/L4 entries bigip_apm_acl: name: L7L4foo acl_order: 2 type: static path_match_case: no entries: - action: allow host_name: 'foobar.com' paths: '/shopfront' scheme: https dst_port: '8181' dst_addr: '192.168.1.1' protocol: tcp - action: reject dst_addr: '192.168.1.1' host_name: 'internal_foobar.com' paths: '/admin' scheme: any protocol: all log: packet provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Modify a static ACL entries bigip_apm_acl: name: L4foo entries: - action: allow dst_port: '80' dst_addr: '192.168.1.1' src_port: '443' src_addr: '10.10.10.0' src_mask: '255.255.255.128' protocol: tcp - action: discard dst_port: '' dst_addr: 192.168.1.1 src_port: '' src_addr: '10.10.10.0' src_mask: '255.2155.255.128' protocol: all provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove static ACL bigip_apm_acl: name: L4foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| acl\_order integer \| changed \| The order of this ACL relative to other ACLs. Sample: 10 \| \| description string \| changed \| The new description of the ACL. Sample: My ACL \| \| entries complex \| changed \| Access control entries that define the ACL matching and its respective behavior. Sample: hash/dictionary of values \| \| \| action string \| changed \| Action the access control entry takes when a match for this access control entry is encountered. Sample: allow \| \| \| dst\_addr string \| changed \| The destination IP address for the access control entry. Sample: 192.168.0.1 \| \| \| dst\_mask string \| changed \| The destination network mask for the access control entry. Sample: 255.255.255.128 \| \| \| dst\_port string \| changed \| The destination port for the access control entry. Sample: 80 \| \| \| dst\_port\_range string \| changed \| The destination port range for the access control entry. Sample: 80-81 \| \| \| host\_name string \| changed \| The host to which the access control entry applies. Sample: foobar.com \| \| \| log string \| changed \| The log level that is logged when actions of this type occur. Sample: packet \| \| \| paths string \| changed \| The path or paths to which the access control entry applies. Sample: /fooshop \| \| \| protocol string \| changed \| The protocol to which the access control entry applies. Sample: tcp \| \| \| scheme string \| changed \| The URI scheme on which the access control entry operates. Sample: https \| \| \| src\_addr string \| changed \| The source IP address for the access control entry. Sample: 192.168.0.1 \| \| \| src\_mask string \| changed \| The source network mask for the access control entry. Sample: 255.255.255.128 \| \| \| src\_port string \| changed \| The source port for the access control entry. Sample: 80 \| \| \| src\_port\_range string \| changed \| The source port range for the access control entry. Sample: 80-81 \| \| path\_match\_case boolean \| changed \| Specifies whether alphabetic case is considered when matching paths in an access control entry. Sample: True \| \| type string \| changed \| The type of ACL to create. Sample: static \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_gtm_monitor_bigip – Manages F5 BIG-IP GTM BIG-IP monitors f5networks.f5\_modules.bigip\_gtm\_monitor\_bigip – Manages F5 BIG-IP GTM BIG-IP monitors ========================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_gtm_monitor_bigip`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP GTM (now BIG-IP DNS) BIG-IP monitors. This monitor is used by GTM to monitor BIG-IPs themselves. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| aggregate\_dynamic\_ratios string \| Choices:* none * average-nodes * sum-nodes * average-members * sum-members \| Specifies how the system combines the module values to create the proportion (score) for the load balancing operation. The score represents the module's estimated capacity for handing traffic. Averaged values are appropriate for downstream Web Accelerator or Application Security Manager (ASM) virtual servers. When creating a new monitor, if this parameter is not specified, the default of `none` is used, meaning the system does not use the scores in the load balancing operation. When `none`, specifies the monitor ignores the nodes and pool member scores. When `average-nodes`, specifies the system averages the dynamic ratios on the nodes associated with the monitor's target virtual servers and returns that average as the virtual servers' score. When `sum-nodes`, specifies the system adds together the scores of the nodes associated with the monitor's target virtual servers and uses that value in the load balancing operation. When `average-members`, specifies the system averages the dynamic ratios on the pool members associated with the monitor's target virtual servers and returns that average as the virtual servers' score. When `sum-members`, specifies the system adds together the scores of the pool members associated with the monitor's target virtual servers and uses that value in the load balancing operation. \| \| ignore\_down\_response boolean \| Choices:* no * yes \| Specifies the monitor allows more than one probe attempt per interval. When `yes`, specifies the monitor ignores down responses for the duration of the monitor timeout. Once the monitor timeout is reached without the system receiving an up response, the system marks the object down. When `no`, specifies the monitor immediately marks an object down when it receives a down response. When creating a new monitor, if this parameter is not provided, the default value will be `no`. \| \| interval integer \| \| Specifies, in seconds, the frequency at which the system issues the monitor check when either the resource is down or the status of the resource is unknown. When creating a new monitor, if this parameter is not provided, the default value will be `30`. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. \| \| name* string / required \| \| Name of the monitor. \| \| parent string \| Default:"/Common/bigip" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `bigip` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be '\'. Note that if specifying an IP address, you must use a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| timeout integer \| \| Specifies the number of seconds the target has in which to respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. When this value is set to 0 (zero), the system uses the interval from the parent monitor. When creating a new monitor, if this parameter is not provided, the default value will be `90`. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create BIG-IP Monitor bigip_gtm_monitor_bigip: state: present ip: 10.10.10.10 name: my_monitor provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove BIG-IP Monitor bigip_gtm_monitor_bigip: state: absent name: my_monitor provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Add BIG-IP monitor for all addresses, port 514 bigip_gtm_monitor_bigip: port: 514 name: my_monitor provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| aggregate\_dynamic\_ratios string \| changed \| The new aggregate of to the monitor. Sample: sum-members \| \| ignore\_down\_response boolean \| changed \| Whether to ignore the down response or not. Sample: True \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: bigip \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_command – Run TMSH and BASH commands on F5 devices f5networks.f5\_modules.bigip\_command – Run TMSH and BASH commands on F5 devices ================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_command`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Sends a TMSH or BASH command to a BIG-IP node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. * This module is not idempotent, nor will it ever be. It is intended as a stop-gap measure to satisfy automation requirements until such a time as a real module has been developed to configure in the way you need. * If you are using this module, we recommend also filing an issue to have a real module created for your needs. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| chdir string \| \| Change into this directory before running the command. \| \| commands raw / required \| \| The commands to send to the remote BIG-IP device over the configured provider. The resulting output from the command is returned. If the wait\_for argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired. Only `tmsh` commands are supported. If you are piping or adding additional logic that is outside of `tmsh` (such as grep'ing, awk'ing or other shell related logic that are not `tmsh`), this behavior is not supported. \| \| interval integer \| Default:1 \| Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again. \| \| match string \| Choices:* any * all ← \| The match argument is used in conjunction with the wait\_for argument to specify the match policy. Valid values are `all` or `any`. If the value is set to `all`, then all conditionals in the wait\_for must be satisfied. If the value is set to `any` then only one of the values must be satisfied. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| ssh\_keyfile path \| \| Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* cli * rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| retries integer \| Default:10 \| Specifies the number of retries a command should be tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait\_for conditionals. \| \| wait\_for list / elements=string \| \| Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See the examples. aliases: waitfor \| \| warn boolean \| Choices:* no * yes ← \| Whether the module should raise warnings related to command idempotency or not. Note that the F5 Ansible developers specifically leave this on to make you aware that your usage of this module may be better served by official F5 Ansible modules. This module should always be used as a last resort. \| Notes ----- Note * When running this module in an HA environment via SSH connection and using a role other than `admin` or `root`, you may see a `Change Pending` status, even if you did not make any changes. This is being tracked with ID429869. * When using the bigip\_command module with the REST API, there are a number of places regex is used internally to escape characters such as quotation marks. If your TMSH command contains regex characters itself, such as datagroup wildcards ``, then a large amount of escape characters may be needed. For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: run show version on remote devices bigip_command: commands: show sys version provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost - name: run show version and check to see if output contains BIG-IP bigip_command: commands: show sys version wait_for: result[0] contains BIG-IP provider: server: lb.mydomain.com password: secret user: admin register: result delegate_to: localhost - name: run multiple commands on remote nodes bigip_command: commands: - show sys version - list ltm virtual provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost - name: run multiple commands and evaluate the output bigip_command: commands: - show sys version - list ltm virtual wait_for: - result[0] contains BIG-IP - result[1] contains my-vs provider: server: lb.mydomain.com password: secret user: admin register: result delegate_to: localhost - name: tmsh prefixes will automatically be handled bigip_command: commands: - show sys version - tmsh list ltm virtual provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost - name: Delete all LTM nodes in Partition1, assuming no dependencies exist bigip_command: commands: - delete ltm node all chdir: Partition1 provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost - name: Command that contains wildcard character to be passed to tmsh bigip_command: commands: - modify ltm data-group internal dg_string records add { "my test\\\\\\\string" { data "value" }} provider: server: lb.mydomain.com password: secret user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| failed\_conditions* list / elements=string \| failed \| The list of conditionals that have failed. Sample: ['...', '...'] \| \| stdout list / elements=string \| always \| The set of responses from the commands. Sample: ['...', '...'] \| \| stdout\_lines list / elements=string \| always \| The value of stdout split into a list. Sample: [['...', '...'], ['...'], ['...']] \| \| warn boolean \| changed \| Whether or not to raise warnings about modification commands. Sample: True \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_device_group_member – Manages members in a device group f5networks.f5\_modules.bigip\_device\_group\_member – Manages members in a device group ======================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_device_group_member`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manages members in a device group. Members in a device group can only be added or removed, never updated. This is because the members are identified by unique name values and changing that name would invalidate the uniqueness. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| device\_group string / required \| \| The device group to which you want to add the member. \| \| name string / required \| \| Specifies the name of the device that you want to add to the device group. Often this will be the hostname of the device. This member must be trusted by the device already. Trusting can be done with the `bigip_device_trust` module and the `peer_hostname` option to that module. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the device group member exists. When `absent`, ensures the device group member is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Add the current device to the "device_trust_group" device group bigip_device_group_member: name: "{{ inventory_hostname }}" device_group: device_trust_group provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Add the hosts in the current scope to "device_trust_group" bigip_device_group_member: name: "{{ item }}" device_group: device_trust_group provider: password: secret server: lb.mydomain.com user: admin loop: "{{ hostvars.keys() }}" run_once: true delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_apm_policy_fetch – Exports the APM policy or APM access profile from remote nodes. f5networks.f5\_modules.bigip\_apm\_policy\_fetch – Exports the APM policy or APM access profile from remote nodes. ================================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_apm_policy_fetch`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Exports the APM policy or APM access profile from remote nodes. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| dest path \| \| A directory to save the file into. \| \| file string \| \| The name of the file to be created on the remote device for downloading. \| \| force boolean \| Choices:* no * yes ← \| If `no`, the file will only be transferred if it does not exist in the the destination. \| \| name string / required \| \| The name of the APM policy or APM access profile exported to create a file on the remote device for downloading. \| \| partition string \| Default:"Common" \| Device partition which contains the APM policy or APM access profile to export. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| type string \| Choices:* profile\_access ← * access\_policy \| Specifies the type of item to export from the device. \| Notes ----- Note * Due to ID685681 it is not possible to execute ng\_\* tools via REST API on v12.x and 13.x, once this is fixed this restriction will be removed. * Requires BIG-IP >= 14.0.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Export APM access profile bigip_apm_policy_fetch: name: foobar file: export_foo dest: /root/download provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Export APM access policy bigip_apm_policy_fetch: name: foobar file: export_foo dest: /root/download type: access_policy provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Export APM access profile, autogenerate name bigip_apm_policy_fetch: name: foobar dest: /root/download provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| dest string \| changed \| Local path to download the exported APM policy. Sample: /root/downloads/profile-foobar\_file.conf.tar.gz \| \| file string \| changed \| Name of the exported file on the remote BIG-IP to download. If not specified, then this will be a randomly generated filename. Sample: foobar\_file \| \| name string \| changed \| Name of the APM policy or APM access profile to be exported. Sample: APM\_policy\_global \| \| type string \| changed \| Set to specify the type of item to export. Sample: access\_policy \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_tcp – Manages F5 BIG-IP LTM TCP monitors f5networks.f5\_modules.bigip\_monitor\_tcp – Manages F5 BIG-IP LTM TCP monitors =============================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_tcp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages F5 BIG-IP LTM TCP monitors via iControl REST API. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| The description of the monitor. \| \| interval integer \| \| The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value is 5. This value must be less than the `timeout` value. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If this value is an IP address, and the `type` is `tcp` (the default), then a `port` number must be specified. In BIG IP Management UI, this field is Alias Address. aliases: alias\_address \| \| name* string / required \| \| Monitor name. \| \| parent string \| Default:"/Common/tcp" \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `tcp` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must specify a value between 1 and 65535. This argument is not supported for TCP Echo types. In BIG IP Management UI, this field is Alias Service Port. aliases: alias\_service\_port \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| receive string \| \| The Receive string for the monitor call. \| \| receive\_disable string \| \| The Receive Disable string for the monitor call. This setting works like `receive`, except the system marks the node or pool member disabled when its response matches the `receive_disable` string but not `receive`. To use this setting, you must specify both `receive_disable` and `receive`. \| \| send string \| \| The Send string for the monitor call. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| time\_until\_up integer \| \| Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of `0` causes a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, the default value is `0`. \| \| timeout integer \| \| The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered up. If the target does not respond within the set time period, it is considered down. You can change this number to any number you want, however, it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value is 16. \| Notes ----- Note * Requires BIG-IP software version >= 12 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create TCP Monitor bigip_monitor_tcp: state: present name: my_tcp_monitor send: tcp string to send receive: tcp string to receive provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove TCP Monitor bigip_monitor_tcp: state: absent name: my_tcp_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| parent string \| changed \| New parent template of the monitor. Sample: tcp \| \| port string \| changed \| The new port of IP/port definition. Sample: [email protected] \| \| receive string \| changed \| The new Receive string for this monitor. Sample: tcp string to receive \| \| receive\_disable string \| changed \| The new Receive Disable string for this monitor. Sample: tcp string to receive \| \| send string \| changed \| The new Send string for this monitor. Sample: tcp string to send \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_profile_oneconnect – Manage OneConnect profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_oneconnect – Manage OneConnect profiles on a BIG-IP ========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_oneconnect`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OneConnect profiles on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description of the profile. \| \| idle\_timeout\_override string \| \| Specifies the number of seconds a connection is idle before the connection flow is eligible for deletion. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. You may specify a number of seconds for the timeout override. When `disabled`, specifies there is no timeout override for the connection. When `indefinite`, specifies a connection may be idle with no timeout override. \| \| limit\_type string \| Choices:* none * idle * strict \| When `none`, simultaneous in-flight requests and responses over TCP connections to a pool member are counted toward the limit. This is the historical behavior. When `idle`, idle connections will be dropped as the TCP connection limit is reached. For short intervals, during the overlap of the idle connection being dropped and the new connection being established, the TCP connection limit may be exceeded. When `strict`, the TCP connection limit is honored with no exceptions. This means that idle connections will prevent new TCP connections from being made until they expire, even if they could otherwise be reused. `strict` is not a recommended configuration except in very special cases with short expiration timeouts. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| maximum\_age integer \| \| Specifies the maximum number of seconds allowed for a connection in the connection reuse pool. For any connection with an age higher than this value, the system removes that connection from the re-use pool. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| maximum\_reuse integer \| \| Specifies the maximum number of times that a server-side connection can be reused. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| maximum\_size integer \| \| Specifies the maximum number of connections the system holds in the connection reuse pool. If the pool is already full, a server-side connection closes after the response is completed. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| name string / required \| \| Specifies the name of the OneConnect profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `oneconnect` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| share\_pools boolean \| Choices:* no * yes \| Indicates connections may be shared not only within a virtual server, but also among similar virtual servers. When `yes`, all virtual servers that use the same OneConnect and other internal network profiles can share connections. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| source\_mask string \| \| Specifies a value the system applies to the source address to determine its eligibility for reuse. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The system applies the value of this setting to the server-side source address to determine its eligibility for reuse. A mask of `0` causes the system to share reused connections across all source addresses. A host mask of `32` causes the system to share only those reused connections originating from the same source address. When you are using a SNAT or SNAT pool, the server-side source address is translated first and then the OneConnect mask is applied to the translated address. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a OneConnect profile bigip_profile_oneconnect: name: foo state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| Description of the profile. Sample: My profile \| \| idle\_timeout\_override string \| changed \| The new idle timeout override. Sample: disabled \| \| limit\_type string \| changed \| New limit type of the profile. Sample: idle \| \| maximum\_age integer \| changed \| Maximum number of seconds allowed for a connection in the connection reuse pool. Sample: 2000 \| \| maximum\_reuse integer \| changed \| Maximum number of times a server-side connection can be reused. Sample: 1000 \| \| maximum\_size integer \| changed \| Maximum number of connections the system holds in the connection reuse pool. Sample: 3000 \| \| share\_pools boolean \| changed \| Share connections among similar virtual servers. Sample: True \| \| source\_mask string \| changed \| Value the system applies to the source address to determine its eligibility for reuse. Sample: 255.255.255.255 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_profile_fastl4 – Manages Fast L4 profiles f5networks.f5\_modules.bigip\_profile\_fastl4 – Manages Fast L4 profiles ======================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_fastl4`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages Fast L4 profiles. Using the FastL4 profile can increase virtual server performance and throughput for supported platforms by using the embedded Packet Velocity Acceleration (ePVA) chip to accelerate traffic. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| client\_timeout string \| \| Specifies a timeout for Late Binding. This is the time limit for the client to provide the application data required to select a back-end server, meaning the maximum time the BIG-IP system waits for information about the sender and the target. This information typically arrives at the beginning of the FIX logon packet. When `0`, or `immediate`, allows for no time beyond the moment of the first packet transmission. When `indefinite`, disables the limit. This allows the client unlimited time to send the sender and target information. \| \| description string \| \| Description of the profile. \| \| explicit\_flow\_migration boolean \| Choices:* no * yes \| Specifies whether a qualified late-binding connection requires an explicit iRule command to migrate down to ePVA hardware. When `no`, a late-binding connection migrates down to ePVA immediately after establishing the server-side connection. When `yes`, this parameter stops automatic migration to ePVA, and requires the iRule explicitly trigger ePVA processing by invoking the `release_flow` iRule command. This allows an iRule author to control when the connection uses the ePVA hardware. \| \| hardware\_syn\_cookie boolean \| Choices:* no * yes \| Enables or disables hardware SYN cookie support when PVA10 is present on the system. \| \| idle\_timeout string \| \| Specifies the length of time a connection is idle (has no traffic) before the connection is eligible for deletion. When creating a new profile, if this parameter is not specified, the remote device will choose a default value appropriate for the profile, based on its `parent` profile. When a number is specified, indicates the number of seconds the TCP connection can remain idle before the system deletes it. When `indefinite`, specifies the system does not delete TCP connections regardless of how long they remain idle. When `0`, or `immediate`, specifies the system deletes connections immediately when they become idle. \| \| ip\_df\_mode string \| Choices:* pmtu * preserve * set * clear \| Specifies the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet. When `pmtu`, sets the outgoing IP Header DF bit based on IP pmtu setting. When `preserve`, sets the outgoing Packet's IP Header DF bit to be same as incoming IP Header DF bit. When `set`, sets the outgoing packet's IP Header DF bit. When `clear`, clears the outgoing packet's IP Header DF bit. \| \| ip\_tos\_to\_client string \| \| For IP traffic passing through the system to clients, specifies whether the system modifies the IP type-of-service (ToS) setting in an IP packet header. May be a number between 0 and 255 (inclusive). When a number, specifies the IP ToS setting that the system inserts in the IP packet header. When `pass-through`, specifies the IP ToS setting remains unchanged. When `mimic`, specifies the system sets the ToS level of outgoing packets to the same ToS level of the most-recently received incoming packet. \| \| ip\_tos\_to\_server string \| \| For IP traffic passing through the system to back-end servers, specifies whether the system modifies the IP type-of-service (ToS) setting in an IP packet header. May be a number between 0 and 255 (inclusive). When a number, specifies the IP ToS setting that the system inserts in the IP packet header. When `pass-through`, specifies that IP ToS setting remains unchanged. When `mimic`, specifies the system sets the ToS level of outgoing packets to the same ToS level of the most-recently received incoming packet. \| \| ip\_ttl\_mode string \| Choices:* proxy * preserve * decrement * set \| Specifies the outgoing TCP packet's IP Header TTL mode. When `proxy`, sets the outgoing IP Header TTL value to 255/64 for IPv4/IPv6 respectively. When `preserve`, sets the outgoing IP Header TTL value to be same as the incoming IP Header TTL value. When `decrement`, sets the outgoing IP Header TTL value to be one less than the incoming TTL value. When `set`, sets the outgoing IP Header TTL value to a specific value(as specified by `ip_ttl_v4` or `ip_ttl_v6`. \| \| ip\_ttl\_v4 integer \| \| Specifies the outgoing packet's IP Header TTL value for IPv4 traffic. The maximum TTL value is 255. \| \| ip\_ttl\_v6 integer \| \| Specifies the outgoing packet's IP Header TTL value for IPv6 traffic. The maximum TTL value is 255. \| \| keep\_alive\_interval integer \| \| Specifies the keep-alive probe interval, in seconds. \| \| late\_binding boolean \| Choices:* no * yes \| Enables intelligent selection of a back-end server or pool, using an iRule to make the selection. Enabling `late_binding` on BIG-IP running TMOS 12.x branch requires software syn cookie is enabled. \| \| link\_qos\_to\_client string \| \| For IP traffic passing through the system to clients, specifies whether the system modifies the link quality-of-service (QoS) setting in an IP packet header. The link QoS value prioritizes the IP packet relative to other Layer 2 traffic. You can specify a number between 0 (lowest priority) and 7 (highest priority). When a number, specifies the link QoS setting that the system inserts in the IP packet header. When `pass-through`, specifies the link QoS setting remains unchanged. \| \| link\_qos\_to\_server string \| \| For IP traffic passing through the system to back-end servers, specifies whether the system modifies the link quality-of-service (QoS) setting in an IP packet header. The link QoS value prioritizes the IP packet relative to other Layer 2 traffic. You can specify a number between 0 (lowest priority) and 7 (highest priority). When a number, specifies the link QoS setting that the system inserts in the IP packet header. When `pass-through`, specifies the link QoS setting remains unchanged. \| \| loose\_close boolean \| Choices:* no * yes \| When `yes`, specifies the system closes a loosely-initiated connection when the system receives the first FIN packet from either the client or the server. \| \| loose\_initialization boolean \| Choices:* no * yes \| When `yes`, specifies the system initializes a connection when it receives any TCP packet, rather than requiring a SYN packet for connection initiation. \| \| mss\_override integer \| \| Specifies a maximum segment size (MSS) override for server-side connections. Valid range is 256 to 9162 or 0 to disable. \| \| name string / required \| \| Specifies the name of the profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `fastL4` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| pva\_acceleration string added in 1.3.0 of f5networks.f5\_modules \| Choices:* full * dedicated * partial * none \| Specifies the Packet Velocity ASIC acceleration policy. \| \| reassemble\_fragments boolean \| Choices:* no * yes \| When `yes`, specifies the system reassembles IP fragments. \| \| receive\_window\_size integer \| \| Specifies the amount of data the BIG-IP system can accept without acknowledging the server. \| \| reset\_on\_timeout boolean \| Choices:* no * yes \| When `yes`, specifies the system sends a reset packet (RST) in addition to deleting the connection, when a connection exceeds the idle timeout value. \| \| rtt\_from\_client boolean \| Choices:* no * yes \| When `yes`, specifies the system uses TCP timestamp options to measure the round-trip time to the client. \| \| rtt\_from\_server boolean \| Choices:* no * yes \| When `yes`, specifies the system uses TCP timestamp options to measure the round-trip time to the server. \| \| server\_sack boolean \| Choices:* no * yes \| Specifies whether the BIG-IP system processes Selective ACK (Sack) packets in cookie responses from the server. \| \| server\_timestamp boolean \| Choices:* no * yes \| Specifies whether the BIG-IP system processes timestamp request packets in cookie responses from the server. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| syn\_cookie\_enable boolean added in 1.11.0 of f5networks.f5\_modules \| Choices:* no * yes \| Specifies whether or not to use SYN Cookie. \| \| syn\_cookie\_mss integer \| \| Specifies a value that overrides the SYN cookie maximum segment size (MSS) value in the SYN-ACK packet that is returned to the client. Valid values are 0, and values from 256 through 9162. Parameter only available on TMOS 13.0.0 and higher. \| \| tcp\_close\_timeout string \| \| Specifies the length of time a connection can remain idle before deletion. \| \| tcp\_generate\_isn boolean \| Choices:* no * yes \| When `yes`, specifies the system generates initial sequence numbers for SYN packets, according to RFC 1948. \| \| tcp\_handshake\_timeout string \| \| Specifies the acceptable duration for a TCP handshake (the maximum idle time between a client synchronization (SYN) and a client acknowledgment (ACK)). If the TCP handshake takes longer than the timeout, the system automatically closes the connection. When a number, specifies how long the system can try to establish a TCP handshake before timing out. When `disabled`, specifies the system does not apply a timeout to a TCP handshake. When `indefinite`, specifies attempting a TCP handshake never times out. \| \| tcp\_strip\_sack boolean \| Choices:* no * yes \| When `yes`, specifies the system blocks a TCP selective ACK SackOK option from passing to the server on an initiating SYN. \| \| tcp\_time\_wait\_timeout integer \| \| Specifies the number of milliseconds a connection is in the TIME-WAIT state before closing. This parameter is only available on TMOS 13.0.0 and later. \| \| tcp\_timestamp\_mode string \| Choices:* preserve * rewrite * strip \| Specifies the action the system should take on TCP timestamps. \| \| tcp\_wscale\_mode string \| Choices:* preserve * rewrite * strip \| Specifies the action the system should take on TCP windows. \| \| timeout\_recovery string \| Choices:* disconnect * fallback \| Specifies how to handle client-timeout errors for Late Binding. Timeout errors may be caused by a DoS attack or a lossy connection. When `disconnect`, causes the BIG-IP system to drop the connection. When `fallback`, reverts the connection to normal FastL4 load-balancing, based on the client's TCP header. This causes the BIG-IP system to choose a back-end server based only on the source address and port. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a fastL4 profile bigip_profile_fastl4: name: foo provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| client\_timeout string \| changed \| The new client timeout value of the resource. Sample: True \| \| description string \| changed \| The new description. Sample: My description \| \| explicit\_flow\_migration boolean \| changed \| The new flow migration setting. Sample: True \| \| hardware\_syn\_cookie boolean \| changed \| Enables or disables hardware SYN cookie support when PVA10 is present on the system. \| \| idle\_timeout string \| changed \| The new idle timeout setting. Sample: 123 \| \| ip\_df\_mode string \| changed \| The new Don't Fragment Flag (DF) setting. Sample: clear \| \| ip\_tos\_to\_client string \| changed \| The new IP ToS to Client setting. Sample: 100 \| \| ip\_tos\_to\_server string \| changed \| The new IP ToS to Server setting. Sample: 100 \| \| ip\_ttl\_mode string \| changed \| The new Time To Live (TTL) setting. Sample: proxy \| \| ip\_ttl\_v4 integer \| changed \| The new Time To Live (TTL) v4 setting. Sample: 200 \| \| ip\_ttl\_v6 integer \| changed \| The new Time To Live (TTL) v6 setting. Sample: 200 \| \| keep\_alive\_interval integer \| changed \| The new TCP Keep Alive Interval setting. Sample: 100 \| \| late\_binding boolean \| changed \| The new Late Binding setting. Sample: True \| \| link\_qos\_to\_client string \| changed \| The new Link QoS to Client setting. Sample: pass-through \| \| link\_qos\_to\_server string \| changed \| The new Link QoS to Server setting. Sample: 123 \| \| loose\_close boolean \| changed \| The new Loose Close setting. \| \| loose\_initialization boolean \| changed \| The new Loose Initiation setting. \| \| mss\_override integer \| changed \| The new Maximum Segment Size Override setting. Sample: 300 \| \| pva\_acceleration string \| changed \| Specifies the Packet Velocity ASIC acceleration policy. Sample: full \| \| reassemble\_fragments boolean \| changed \| The new Reassemble IP Fragments setting. Sample: True \| \| receive\_window\_size integer \| changed \| The new Receive Window setting. Sample: 1024 \| \| reset\_on\_timeout boolean \| changed \| The new Reset on Timeout setting. \| \| rtt\_from\_client boolean \| changed \| The new RTT from Client setting. \| \| rtt\_from\_server boolean \| changed \| The new RTT from Server setting. \| \| server\_sack boolean \| changed \| The new Server Sack setting. Sample: True \| \| server\_timestamp boolean \| changed \| The new Server Timestamp setting. Sample: True \| \| syn\_cookie\_enable boolean \| changed \| Specifies whether or not to use SYN Cookie. \| \| syn\_cookie\_mss integer \| changed \| The new SYN Cookie MSS setting. Sample: 1024 \| \| tcp\_close\_timeout string \| changed \| The new TCP Close Timeout setting. Sample: 100 \| \| tcp\_generate\_isn boolean \| changed \| The new Generate Initial Sequence Number setting. \| \| tcp\_handshake\_timeout integer \| changed \| The new TCP Handshake Timeout setting. Sample: 5 \| \| tcp\_strip\_sack boolean \| changed \| The new Strip Sack OK setting. \| \| tcp\_time\_wait\_timeout integer \| changed \| The new TCP Time Wait Timeout setting. Sample: 100 \| \| tcp\_timestamp\_mode string \| changed \| The new TCP Timestamp Mode setting. Sample: rewrite \| \| tcp\_wscale\_mode string \| changed \| The new TCP Window Scale Mode setting. Sample: strip \| \| timeout\_recovery string \| changed \| The new Timeout Recovery setting. Sample: fallback \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_firewall_dos_profile – Manage AFM DoS profiles on a BIG-IP f5networks.f5\_modules.bigip\_firewall\_dos\_profile – Manage AFM DoS profiles on a BIG-IP ========================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_dos_profile`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages AFM (Advanced Firewall Manager) Denial of Service (DoS) profiles on a BIG-IP. To manage the vectors associated with a DoS profile, refer to the `bigip_firewall_dos_vector` module. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| default\_whitelist string \| \| The default whitelist address list for the system to use to determine which IP addresses are legitimate. The system does not examine traffic from the IP addresses in the list when performing DoS prevention. To define a new whitelist, use the `bigip_firewall_address_list` module. \| \| description string \| \| The description of the DoS profile. \| \| name string / required \| \| Specifies the name of the profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the resource exists. When `absent`, ensures the resource is removed. \| \| threshold\_sensitivity string \| Choices:* low * medium * high \| Specifies the threshold sensitivity for the DoS profile. Thresholds for detecting attacks are higher when sensitivity is `low`, and lower when sensitivity is `high`. When creating a new profile, if this parameter is not specified, the default is `medium`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a new DoS profile bigip_firewall_dos_profile: name: profile1 description: DoS profile 1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| default\_whitelist string \| changed \| The new whitelist attached to the profile. Sample: /Common/whitelist1 \| \| description string \| changed \| The description of the profile. Sample: New description \| \| threshold\_sensitivity string \| changed \| The new threshold sensitivity of the profile. Sample: low \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_profile_persistence_universal – Manage universal persistence profiles f5networks.f5\_modules.bigip\_profile\_persistence\_universal – Manage universal persistence profiles ===================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_persistence_universal`. New in version 1.1.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages universal persistence profiles on the BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| app\_service string \| \| The iApp service to be associated with this profile. When no service is specified, the default is None. \| \| match\_across\_pools boolean \| Choices:* no * yes \| When `yes`, specifies the system can use any pool that contains this persistence record. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| match\_across\_services boolean \| Choices:* no * yes \| When `yes`, specifies all persistent connections from a client IP address that go to the same virtual IP address also go to the same node. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| match\_across\_virtuals boolean \| Choices:* no * yes \| When `yes`, specifies all persistent connections from the same client IP address go to the same node. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| mirror boolean \| Choices:* no * yes \| When `yes`, specifies if the active unit goes into the standby mode, the system mirrors any persistence records to its peer. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| name string / required \| \| Specifies the name of the profile. \| \| override\_connection\_limit boolean \| Choices:* no * yes \| When `yes`, specifies the system allows you to specify that pool member connection limits will be overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `universal` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rule string \| \| Specifies the iRule used to select a persistence entry. When creating a new profile, if this parameter is not specified, the default is `None`, which disables this setting. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| timeout string \| \| Specifies the duration of the persistence entries. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. To specify an indefinite timeout, use the value `indefinite`. If specifying a numeric timeout, the value must be between `1` and `4294967295`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a profile bigip_profile_persistence_universal: name: foo state: present match_across_services: yes match_across_virtuals: yes mirror: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| app\_service string \| changed \| The iApp service associated with this profile Sample: /Common/good\_service.app/good\_service \| \| match\_across\_pools boolean \| changed \| The new Match Across Pools value. Sample: True \| \| match\_across\_services boolean \| changed \| The new Match Across Services value. \| \| match\_across\_virtuals boolean \| changed \| The new Match Across Virtuals value. Sample: True \| \| mirror boolean \| changed \| The new Mirror value. Sample: True \| \| override\_connection\_limit boolean \| changed \| The new Override Connection Limit value. \| \| parent string \| changed \| The parent profile. Sample: /Common/cookie \| \| rule string \| changed \| The iRule used to select persistence entry. Sample: /Common/\_sys\_https\_redirect \| \| timeout string \| changed \| The duration of the persistence entries. Sample: 180 \| ### Authors * Nitin Khanna (@nitinthewiz) ansible f5networks.f5_modules.bigip_tunnel – Manage tunnels on a BIG-IP f5networks.f5\_modules.bigip\_tunnel – Manage tunnels on a BIG-IP ================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_tunnel`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages tunnels on a BIG-IP. Tunnels are usually based upon a tunnel profile which defines both default arguments and constraints for the tunnel. * Due to this, this module exposes a number of settings that may or may not be related to the type of tunnel you are working with. It is important that you take this into consideration when declaring your tunnel config. * If a specific tunnel does not support the parameter you are considering, the documentation of the parameter will usually make mention of this. Otherwise, when configuring that parameter on the device, the device will notify you. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auto\_last\_hop string \| Choices:* default * enabled * disabled \| Allows you to configure auto last hop on a per-tunnel basis. When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default is `default`. When `default`, means that the system uses the global auto-lasthop setting to send back the request. When `enabled`, allows the system to send return traffic to the MAC address that transmitted the request, even if the routing table points to a different network or interface. As a result, the system can send return traffic to clients even when there is no matching route. \| \| description string \| \| Description of the tunnel. \| \| key integer \| \| When applied to a GRE tunnel, this value specifies an optional field in the GRE header, used to authenticate the source of the packet. When applied to a VXLAN or Geneve tunnel, this value specifies the Virtual Network Identifier (VNI). When applied to an NVGRE tunnel, this value specifies the Virtual Subnet Identifier (VSID). When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is `0`. \| \| local\_address string \| \| Specifies the IP address of the local endpoint of the tunnel. \| \| mode string \| Choices:* bidirectional * inbound * outbound \| Specifies how the tunnel carries traffic. When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default is `bidirectional`. When `bidirectional`, specifies that the tunnel carries both inbound and outbound traffic. When `inbound`, specifies that the tunnel carries only incoming traffic. When `outbound`, specifies that the tunnel carries only outgoing traffic. \| \| mtu integer \| \| Specifies the maximum transmission unit (MTU) of the tunnel. When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is `0`. The valid range is from `0` to `65515`. \| \| name string / required \| \| Specifies the name of the tunnel. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| profile string \| \| Specifies the profile to associate with the tunnel for handling traffic. Depending on your selection, other settings become available or disappear. This parameter may not be changed after it is set. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| remote\_address string \| \| Specifies the IP address of the remote endpoint of the tunnel. For `dslite`, `fec` (when configuring the FEC tunnel for receiving traffic only), `v6rd` (configured as a border relay), or `map`, the tunnel must have an unspecified remote address (any). \| \| secondary\_address string \| \| Specifies a non-floating IP address for the tunnel, to be used with host-initiated traffic. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures that the tunnel exists. When `absent`, ensures the tunnel is removed. \| \| tos string \| \| Specifies the Type of Service (TOS) value to insert in the encapsulating header of transmitted packets. When creating a new tunnel, if this parameter is supported by the tunnel profile but not specified, the default value is `preserve`. When `preserve`, the system copies the TOS value from the inner header to the outer header. You may also specify a numeric value. The possible values are from `0` to `255`. \| \| traffic\_group string \| \| Specifies the traffic group to associate with the tunnel. This value cannot be changed after it is set. This is a limitation of BIG-IP. \| \| transparent boolean \| Choices:* no * yes \| Specifies that the tunnel operates in transparent mode. When `yes`, you can inspect and manipulate the encapsulated traffic flowing through the BIG-IP system. A transparent tunnel terminates a tunnel while presenting the illusion that the tunnel transits the device unmodified (that is, the BIG-IP system appears as if it were an intermediate router that simply routes IP traffic through the device). \| \| use\_pmtu boolean \| Choices:* no * yes \| Enables or disables the tunnel to use the PMTU (Path MTU) information provided by ICMP NeedFrag error messages. If `yes` and the tunnel `mtu` is set to `0`, the tunnel will use the PMTU information. If `yes` and the tunnel `mtu` is fixed to a non-zero value, the tunnel will use the minimum of PMTU and MTU. If `no`, the tunnel will use fixed MTU or calculate its MTU using tunnel encapsulation configurations. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a VXLAN tunnel bigip_tunnel: name: openshift-tunnel local_address: 192.1681.240 key: 0 secondary_address: 192.168.1.100 mtu: 0 use_pmtu: yes tos: preserve auto_last_hop: default traffic_group: traffic-group-1 state: present provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| param1 boolean \| changed \| The new param1 value of the resource. Sample: True \| \| param2 string \| changed \| The new param2 value of the resource. Sample: Foo is bar \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_wait – Wait for a BIG-IP condition before continuing f5networks.f5\_modules.bigip\_wait – Wait for a BIG-IP condition before continuing ================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_wait`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * With this module, you can wait for BIG-IP to be “ready”, meaning the BIG-IP is ready to accept configuration. * This module can take into account situations where the device is in the middle of rebooting due to a configuration change. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| delay integer \| Default:0 \| Number of seconds to wait before starting to poll. \| \| msg string \| \| This overrides the normal error message from a failure to meet the required conditions. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| ssh\_keyfile path \| \| Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* cli * rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| sleep integer \| Default:1 \| Number of seconds to sleep between checks. Before version 2.3 this was hardcoded to 1 second. \| \| timeout integer \| Default:7200 \| Maximum number of seconds to wait. When used without other conditions, it is equivalent of just sleeping. The default timeout is deliberately set to 2 hours because there is no individual REST API. \| \| type string \| Choices:* standard ← * vcmp \| The type of the BIG-IP. Defaults to `standard`, the other choice is `vcmp`. This choice defines which module or service Ansible looks for to establish that the device has recovered, so ensure to specify the correct choice, especially when running this against VCMP. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Wait for BIG-IP to be ready to take configuration bigip_wait: provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Wait a maximum of 300 seconds for BIG-IP to be ready to take configuration bigip_wait: timeout: 300 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Wait for BIG-IP to be ready, don't start checking for 10 seconds bigip_wait: delay: 10 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_profile_http2 – Manage HTTP2 profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_http2 – Manage HTTP2 profiles on a BIG-IP ================================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_http2`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage HTTP2 profiles on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| activation\_modes list / elements=string \| Choices:* alpn * always \| Specifies what will cause an incoming connection to be handled as a HTTP/2 connection. The `alpn` and `always` are mutually exclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| description string \| \| Description of the profile. \| \| enforce\_tls\_requirements boolean \| Choices:* no * yes \| Specifies whether the system requires TLS for communications between specified senders and recipients. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| frame\_size integer \| \| Specifies the size of data frames, in bytes, that HTTP/2 sends to the client. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range in bytes is `1024 - 16384`. \| \| header\_table\_size integer \| \| Specifies the size of the header table, in bytes. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range in bytes is `0 - 65535`. \| \| idle\_timeout integer \| \| Specifies the number of seconds an HTTP/2 connection is idly left open before being shut down. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| insert\_header boolean \| Choices:* no * yes \| Specifies whether an HTTP header indicating the use of HTTP/2 should be inserted into the request that goes to the server. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| insert\_header\_name string \| \| Specifies the name of the HTTP header controlled by `insert_header` parameter. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| name string / required \| \| Specifies the name of the profile. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `http2` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| receive\_window integer \| \| Specifies the way the HTTP/2 profile performs flow control. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range in kilobytes is `16 - 128`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| \| streams integer \| \| Specifies the number of outstanding concurrent requests allowed on a single HTTP/2 connection. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range is `1 - 256`. \| \| write\_size integer \| \| Specifies the total size of combined data frames, in bytes, that HTTP/2 sends in a single write. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range in bytes is `2048 - 32768`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create HTTP2 profile bigip_profile_http2: name: my_profile insert_header: yes insert_header_name: FOO state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Remove HTTP profile bigip_profile_http2: name: my_profile state: absent provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add HTTP profile set activation modes bigip_profile_http: name: my_profile activation_modes: - always provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| activation\_modes list / elements=string \| changed \| Specifies HTTP/2 connection handling modes. Sample: ['always'] \| \| description string \| changed \| Description of the profile. Sample: My profile \| \| enforce\_tls\_requirements boolean \| changed \| Specifies whether the system requires TLS for communications. Sample: True \| \| frame\_size integer \| changed \| The size of the data frames. Sample: 30 \| \| insert\_header\_name string \| changed \| Specifies the name of the HTTP2 header. Sample: X-HTTP2 \| \| streams integer \| changed \| The number of outstanding concurrent requests allowed on a single HTTP/2 connection. Sample: 30 \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigiq_application_fastl4_udp – Manages BIG-IQ FastL4 UDP applications f5networks.f5\_modules.bigiq\_application\_fastl4\_udp – Manages BIG-IQ FastL4 UDP applications =============================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigiq_application_fastl4_udp`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IQ applications used for load balancing a UDP-based application. with a FastL4 profile. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| add\_analytics boolean \| Choices:* no ← * yes \| Collects statistics of the BIG-IP to which the application is deployed. This parameter is only relevant when specifying a `service_environment` which is a BIG-IP; not an SSG. \| \| description string \| \| Description of the application. \| \| inbound\_virtual dictionary \| \| Settings to configure the virtual which receives the inbound connection. \| \| \| address string / required \| \| Specifies destination IP address information to which the virtual server sends traffic. This parameter is required when creating a new application. \| \| \| netmask string / required \| \| Specifies the netmask to associate with the given `destination`. This parameter is required when creating a new application. \| \| \| port string \| Default:53 \| The port on which the virtual listens for connections. When creating a new application, if this parameter is not specified, the default value is `53`. \| \| name string / required \| \| Name of the new application. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| servers list / elements=dictionary \| \| A list of servers on which the application is hosted. If you are familiar with other BIG-IP settings, you might also refer to this list as the list of pool members. When creating a new application, at least one server is required. \| \| \| address string / required \| \| The IP address of the server. \| \| \| port string \| Default:8000 \| The port of the server. When creating a new application and specifying a server, if this parameter is not provided, the default is `8000`. \| \| service\_environment string \| \| Specifies the name of service environment to which the application is deployed. When creating a new application, this parameter is required. The service environment type is automatically discovered by this module. Therefore, it is crucial you maintain unique names for items in the different service environment types. SSGs are not supported for this type of application. \| \| state string \| Choices:* absent * present ← \| The state of the resource on the system. When `present`, guarantees the resource exists with the provided attributes. When `absent`, removes the resource from the system. \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the application to be created, deleted, or updated. \| Notes ----- Note * This module does not support updating of your application (whether deployed or not). If you need to update the application, we recommend removing and recreating it. * This module will not work on BIG-IQ version 6.1.x or greater. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Load balance a UDP-based application with a FastL4 profile bigiq_application_fastl4_udp: name: my-app description: My description service_environment: my-bigip-device servers: - address: 1.2.3.4 port: 8080 - address: 5.6.7.8 port: 8080 inbound_virtual: name: foo address: 2.2.2.2 netmask: 255.255.255.255 port: 53 provider: password: secret server: lb.mydomain.com user: admin state: present delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description of the application of the resource. Sample: My application \| \| inbound\_virtual\_destination string \| changed \| The destination of the virtual that was created. Sample: 6.7.8.9 \| \| inbound\_virtual\_netmask string \| changed \| The network mask of the provided inbound destination. Sample: 255.255.255.0 \| \| inbound\_virtual\_port integer \| changed \| The port on which the inbound virtual address listens. Sample: 80 \| \| servers complex \| changed \| List of servers, and their ports, that make up the application. Sample: hash/dictionary of values \| \| \| address string \| changed \| The IP address of the server. Sample: 2.3.4.5 \| \| \| port integer \| changed \| The port on which the server listens. Sample: 8080 \| \| service\_environment string \| changed \| The environment to which the service was deployed. Sample: my-ssg1 \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_monitor_mysql – Manages BIG-IP MySQL monitors f5networks.f5\_modules.bigip\_monitor\_mysql – Manages BIG-IP MySQL monitors ============================================================================ Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_monitor_mysql`. New in version 1.3.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages BIG-IP MySQL monitors. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| app\_service string \| \| The iApp service to be associated with this profile. When no service is specified, the default is None. \| \| count integer \| \| Specifies the number of monitor probes after which the connection to the database is terminated. \| \| database string \| \| Specifies the name of the database that the monitor tries to access. \| \| debug boolean \| Choices:* no * yes \| Specifies whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. \| \| description string \| \| Specifies descriptive text that identifies the monitor. \| \| interval integer \| \| Specifies the frequency at which the system issues the monitor check. \| \| ip string \| \| IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value is '\'. \| \| manual\_resume* boolean \| Choices:* no * yes \| Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to `yes`, you must manually re-enable the resource before the system can use it for load balancing connections. When `yes`, specifies you must manually re-enable the resource after an unsuccessful monitor check. When `no`, specifies the system automatically changes the status of a resource to enabled at the next successful monitor check. \| \| name string / required \| \| Monitor name. \| \| parent string \| \| The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the `mysql` parent on the `Common` partition. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| port string \| \| Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '\'. If specifying an IP address, you must specify a value between 1 and 65535. \| \| provider* dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| recv string \| \| Specifies the text string the monitor looks for in the returned resource. The most common receive expressions contain a text string that is included in a field in your database. If you do not specify both a Send String and a Receive String, the monitor performs a simple service check and connect only. \| \| recv\_column string \| \| Specifies the column in the database where the system expects the specified Receive String to be located. This is an optional setting, and is applicable only if you configure the `send` and `recv` options. \| \| recv\_row string \| \| Specifies the row in the database where the system expects the specified Receive String to be located. This is an optional setting, and is applicable only if you configure the `send` and `recv` options. \| \| send string \| \| Specifies the SQL query the monitor sends to the target object. Because the string may have special characters, the system may require the string be enclosed with single quotation marks. If this value is `none`, then a valid connection suffices to determine that the service is up. In this case, the system does not need the recv, recv-row, and recv-column options and ignores them even if not `none`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the monitor exists. When `absent`, ensures the monitor is removed. \| \| target\_password string \| \| Specifies the password if the monitored target requires authentication. \| \| target\_username string \| \| Specifies the user name if the monitored target requires authentication. \| \| time\_until\_up integer \| \| Specifies the number of seconds to wait after a resource first responds correctly to the monitor before setting the resource to 'up'. During the interval, all responses from the resource must be correct. When the interval expires, the resource is marked 'up'. A value of 0, means that the resource is marked up immediately upon receipt of the first correct response. \| \| timeout integer \| \| Specifies the number of seconds the target has in which to respond to the monitor request. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. When this value is set to 0 (zero), the system uses the interval from the parent monitor. Note that `timeout` and `time_until_up` combine to control when a resource is set to up. \| \| up\_interval integer \| \| Specifies the interval for the system to use to perform the health check when a resource is up. When `0`, specifies the system uses the interval specified in `interval` to check the health of the resource. When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. \| \| update\_password string \| Choices:* always ← * on\_create \| `always` will update passwords if the `target_password` is specified. `on_create` will only set the password for newly created monitors. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an mysql monitor bigip_monitor_mysql: ip: 10.10.10.10 port: 10923 name: my_mysql_monitor send: "SELECT status FROM v$instance" recv: OPEN recv_column: 2 recv_row: 1 database: primary1 target_username: bigip target_password: secret update_password: on_create state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Modify an mysql monitor bigip_monitor_mysql: name: my_mysql_monitor recv_column: 4 recv_row: 3 database: primary2 state: present provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove mysql monitor bigip_monitor_mysql: state: absent name: my_mysql_monitor provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| app\_service string \| changed \| The iApp service associated with this monitor. Sample: /Common/good\_service.app/good\_service \| \| database string \| changed \| The name of the database the monitor tries to access. Sample: primary1 \| \| debug boolean \| changed \| Whether the monitor sends error messages and additional information to a log file created and labeled specifically for this monitor. \| \| description string \| changed \| The description of the monitor. Sample: Important Monitor \| \| interval integer \| changed \| The new interval at which to run the monitor check. Sample: 2 \| \| ip string \| changed \| The new IP of IP/port definition. Sample: 10.12.13.14 \| \| manual\_resume boolean \| changed \| Specifies whether the system automatically changes the status of a resource to up at the next successful monitor check. Sample: True \| \| parent string \| changed \| The parent monitor. Sample: /Common/foo\_mysql \| \| port string \| changed \| Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Sample: 80 \| \| recv string \| changed \| The text string the monitor looks for in the returned resource. Sample: OPEN \| \| recv\_column string \| changed \| The column in the database where the specified string should be located. Sample: 2 \| \| recv\_row string \| changed \| The row in the database where the specified string should be located. Sample: 1 \| \| send string \| changed \| The SQL query the monitor sends to the target object. Sample: SELECT status FROM v$instance \| \| target\_username string \| changed \| The user name for the the monitored target. Sample: bigip \| \| time\_until\_up integer \| changed \| The new time in which to mark a system as up after first successful response. Sample: 2 \| \| timeout integer \| changed \| The new timeout in which the remote system must respond to the monitor. Sample: 10 \| \| up\_interval integer \| changed \| Interval for the system to use to perform the health check when a resource is up. \| ### Authors * Andrey Kashcheev (@andreykashcheev) ansible f5networks.f5_modules.bigip_asm_dos_application – Manage application settings for a DOS profile f5networks.f5\_modules.bigip\_asm\_dos\_application – Manage application settings for a DOS profile =================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_asm_dos_application`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages Application settings for an ASM/AFM DOS profile. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| geolocations dictionary \| \| Manages the geolocations countries whitelist, blacklist. \| \| \| blacklist list / elements=string \| \| A list of countries to be put on the blacklist, must not have overlapping elements with `whitelist`. \| \| \| whitelist list / elements=string \| \| A list of countries to be put on the whitelist, must not have overlapping elements with `blacklist`. \| \| heavy\_urls dictionary \| \| Manages Heavy URL protection. Heavy URLs are a small number of site URLs that might consume considerable server resources per request. \| \| \| auto\_detect boolean \| Choices:* no * yes \| Enables or disables automatic heavy URL detection. \| \| \| exclude list / elements=string \| \| Specifies a list of URLs or wildcards to exclude from the heavy URLs. \| \| \| include list / elements=dictionary \| \| Configures additional URLs to include in the heavy URLs that were auto-detected. \| \| \| \| threshold string \| \| Specifies the threshold of requests per second, where the URL in question is considered under attack. The acceptable range is between 1 and 4294967295 inclusive, or `auto`. \| \| \| \| url string / required \| \| Specifies the URL to be added to the list of heavy URLs, in addition to those automatically detected. \| \| \| latency\_threshold integer \| \| Specifies the latency threshold for automatic heavy URL detection. The acceptable range is between 0 and 4294967295 miliseconds inclusive. \| \| mobile\_detection dictionary \| \| Configures detection of mobile applications built with the Anti-Bot Mobile SDK and defines how requests from these mobile application clients are handled. \| \| \| allow\_android\_rooted\_device boolean \| Choices:* no * yes \| When `yes` the device will allow traffic from rooted Android devices. \| \| \| allow\_any\_android\_package boolean \| Choices:* no * yes \| When `yes` allows any application publisher. A publisher is identified by the certificate used to sign the application. \| \| \| allow\_any\_ios\_package boolean \| Choices:* no * yes \| When `yes` allows any iOS package. A package name is the unique identifier of the mobile application. \| \| \| allow\_emulators boolean \| Choices:* no * yes \| When `yes` allows traffic from applications run on emulators. \| \| \| allow\_jailbroken\_devices boolean \| Choices:* no * yes \| When `yes` allows traffic from jailbroken iOS devices. \| \| \| android\_publishers list / elements=string \| \| This option has no effect when `allow_any_android_package` is set to `yes`. Specifies the allowed publisher certificates for android applications. The publisher certificate needs to be installed on the BIG-IP beforehand. The certificate name located on a different partition than the one specified in the `partition` parameter needs to be provided in `full_path` format, e.g. `/Foo/cert.crt`. \| \| \| client\_side\_challenge\_mode string \| Choices:* pass * cshui \| Action to take when a CAPTCHA or Client Side Integrity challenge needs to be presented. The mobile application user will not see a CAPTCHA challenge and the mobile application will not be presented with the Client Side Integrity challenge. The such options for mobile applications are `pass` or `cshui`. When `pass` the traffic is passed without incident. When `cshui` the SDK checks for human interactions with the screen in the last few seconds. If none are detected, the traffic is blocked. \| \| \| enabled boolean \| Choices:* no * yes \| When `yes`, requests from mobile applications built with Anti-Bot Mobile SDK will be detected and handled according to the parameters set. When `no`, these requests will be handled like any other request which may let attacks in, or cause false positives. \| \| \| ios\_allowed\_package\_names list / elements=string \| \| Specifies the names of iOS packages to allow traffic on. This option has no effect when `allow_any_ios_package` is set to `yes`. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| profile string / required \| \| Specifies the name of the profile to manage application settings in. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rtbh\_duration integer \| \| Specifies the duration of the RTBH BGP route advertisement, in seconds. The acceptable range is between 0 and 4294967295 inclusive. \| \| rtbh\_enable boolean \| Choices:* no * yes \| Specifies whether to enable Remote Triggered Black Hole `RTBH` of attacking IPs by advertising BGP routes. \| \| scrubbing\_duration integer \| \| Specifies the duration of the Traffic Scrubbing BGP route advertisement, in seconds. The acceptable range is between 0 and 4294967295 inclusive. \| \| scrubbing\_enable boolean \| Choices:* no * yes \| Specifies whether to enable Traffic Scrubbing during attacks by advertising BGP routes. \| \| single\_page\_application boolean \| Choices:* no * yes \| Specifies, when `yes`, that the system supports a Single Page Applications. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures that the Application object exists. When `state` is `absent`, ensures that the Application object is removed. \| \| trigger\_irule boolean \| Choices:* no * yes \| Specifies, when `yes`, that the system activates an Application DoS iRule event. \| Notes ----- Note * Requires BIG-IP >= 13.1.0 * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an ASM dos application profile bigip_asm_dos_application: profile: dos_foo geolocations: blacklist: - Afghanistan - Andora whitelist: - Cuba heavy_urls: auto_detect: yes latency_threshold: 1000 rtbh_duration: 3600 rtbh_enable: yes single_page_application: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update an ASM dos application profile bigip_asm_dos_application: profile: dos_foo mobile_detection: enabled: yes allow_any_ios_package: yes allow_emulators: yes provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove an ASM dos application profile bigip_asm_dos_application: profile: dos_foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| geolocations complex \| changed \| Specifies geolocations countries whitelist, blacklist. Sample: hash/dictionary of values \| \| \| blacklist list / elements=string \| changed \| A list of countries to be put on the blacklist. Sample: ['Russia', 'Germany'] \| \| \| whitelist list / elements=string \| changed \| A list of countries to be put on the whitelist. Sample: ['United States, United Kingdom'] \| \| heavy\_urls complex \| changed \| Manages Heavy URL protection. Sample: hash/dictionary of values \| \| \| auto\_detect boolean \| changed \| Enables or disables automatic heavy URL detection. Sample: True \| \| \| exclude list / elements=string \| changed \| Specifies a list of URLs or wildcards to exclude from the heavy URLs. Sample: ['/exclude.html', '/exclude2.html'] \| \| \| include complex \| changed \| Configures additional URLs to include in the heavy URLs. Sample: hash/dictionary of values \| \| \| \| threshold string \| changed \| The threshold of requests per second. Sample: auto \| \| \| \| url string \| changed \| The URL to be added to the list of heavy URLs. Sample: /include.html \| \| \| latency\_threshold integer \| changed \| Specifies the latency threshold for automatic heavy URL detection. Sample: 2000 \| \| mobile\_detection complex \| changed \| Configures detection of mobile applications built with the Anti-Bot Mobile SDK. Sample: hash/dictionary of values \| \| \| allow\_android\_rooted\_device boolean \| changed \| Allows traffic from rooted Android devices. \| \| \| allow\_any\_android\_package boolean \| changed \| Allows any application publisher. \| \| \| allow\_any\_ios\_package boolean \| changed \| Allows any iOS package. Sample: True \| \| \| allow\_emulators boolean \| changed \| Allows traffic from applications run on emulators. Sample: True \| \| \| allow\_jailbroken\_devices boolean \| changed \| Allows traffic from jailbroken iOS devices. \| \| \| android\_publishers list / elements=string \| changed \| The allowed publisher certificates for android applications. Sample: ['/Common/cert1.crt', '/Common/cert2.crt'] \| \| \| client\_side\_challenge\_mode string \| changed \| Action to take when a CAPTCHA or Client Side Integrity challenge needs to be presented. Sample: pass \| \| \| enable boolean \| changed \| Enables or disables automatic mobile detection. Sample: True \| \| \| ios\_allowed\_package\_names list / elements=string \| changed \| The names of iOS packages to allow traffic on. Sample: ['package1', 'package2'] \| \| rtbh\_duration integer \| changed \| The duration of the RTBH BGP route advertisement. Sample: 3600 \| \| rtbh\_enable boolean \| changed \| Enables Remote Triggered Black Hole of attacking IPs. \| \| scrubbing\_duration integer \| changed \| The duration of the Traffic Scrubbing BGP route advertisement. Sample: 3600 \| \| scrubbing\_enable boolean \| changed \| Enables Traffic Scrubbing during attacks. Sample: True \| \| single\_page\_application boolean \| changed \| Enables support of Single Page Applications. \| \| trigger\_irule boolean \| changed \| Activates an Application DoS iRule event. Sample: True \| ### Authors * Wojciech Wypior (@wojtek0806)	programming_docs
ansible f5networks.f5_modules.bigip_firewall_global_rules – Manage AFM global rule settings on BIG-IP f5networks.f5\_modules.bigip\_firewall\_global\_rules – Manage AFM global rule settings on BIG-IP ================================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_firewall_global_rules`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Configures the global network firewall rules on AFM (Advanced Firewall Manager). These firewall rules are applied to all packets except those going through the management interface. They are applied first, before any firewall rules for the packet’s virtual server, route domain, and/or self IP address. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| description string \| \| Description for the global list of firewall rules. \| \| enforced\_policy string \| \| Specifies an enforced firewall policy. `enforced_policy` rules are enforced globally. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| service\_policy string \| \| Specifies a service policy that would apply to traffic globally. The service policy is applied to all flows, provided there are no other context specific service policy configurations that override the global service policy. For example, when a service policy is configured both at a global level and on a firewall rule, and a flow matches the rule, the more specific service policy configuration in the rule will override the service policy setting at the global level. The service policy associated here can be created using the `bigip_service_policy` module. \| \| staged\_policy string \| \| Specifies a staged firewall policy. `staged_policy` rules are not enforced while all the visibility aspects (statistics, reporting, and logging) function as if the staged-policy rules were enforced globally. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Change enforced policy in AFM global rules bigip_firewall_global_rules: enforced_policy: enforcing1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| changed \| The new description. Sample: My description \| \| enforced\_policy string \| changed \| The new global Enforced Policy. Sample: /Common/enforced1 \| \| service\_policy string \| changed \| The new global Service Policy. Sample: /Common/service1 \| \| staged\_policy string \| changed \| The new global Staged Policy. Sample: /Common/staged1 \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_profile_persistence_src_addr – Manage source address persistence profiles f5networks.f5\_modules.bigip\_profile\_persistence\_src\_addr – Manage source address persistence profiles ========================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_persistence_src_addr`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages source address persistence profiles on a BIG-IP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| entry\_timeout string \| \| Specifies the duration of the persistence entries. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. To specify an indefinite timeout, use the value `indefinite`. If specifying a numeric timeout, the value must be between `1` and `4294967295`. \| \| hash\_algorithm string \| Choices:* default * carp \| Specifies the algorithm the system uses for hash persistence load balancing. The hash result is the input for the algorithm. When `default`, specifies the system uses the index of pool members to obtain the hash result for the input to the algorithm. When `carp`, specifies the system uses the Cache Array Routing Protocol (CARP) to obtain the hash result for the input to the algorithm. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| mask string \| \| Specifies a value the system applies as the prefix length. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| match\_across\_pools boolean \| Choices:* no * yes \| When `yes`, specifies the system can use any pool that contains this persistence record. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| match\_across\_services boolean \| Choices:* no * yes \| When `yes`, specifies all persistent connections from a client IP address that go to the same virtual IP address also go to the same node. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| match\_across\_virtuals boolean \| Choices:* no * yes \| When `yes`, specifies all persistent connections from the same client IP address go to the same node. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| mirror boolean \| Choices:* no * yes \| When `yes`, specifies that if the active unit goes into the standby mode, the system mirrors any persistence records to its peer. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. \| \| name string / required \| \| Specifies the name of the profile. \| \| override\_connection\_limit boolean \| Choices:* no * yes \| When `yes`, specifies the system allows you to specify that pool member connection limits will be overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `source_addr` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a profile bigip_profile_persistence_src_addr: name: foo state: present hash_algorithm: carp match_across_services: yes match_across_virtuals: yes mirror: yes mask: 255.255.255.255 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| entry\_timeout string \| changed \| The duration of the persistence entries. Sample: 180 \| \| hash\_algorithm string \| changed \| The algorithm used for hash persistence. Sample: default \| \| mask string \| changed \| The persist mask value. Sample: 255.255.255.255 \| \| match\_across\_pools boolean \| changed \| The new Match Across Pools value. Sample: True \| \| match\_across\_services boolean \| changed \| The new Match Across Services value. \| \| match\_across\_virtuals boolean \| changed \| The new Match Across Virtuals value. Sample: True \| \| mirror boolean \| changed \| The new Mirror value. Sample: True \| \| override\_connection\_limit boolean \| changed \| The new Override Connection Limit value. \| \| parent string \| changed \| The parent profile. Sample: /Common/cookie \| ### Authors * Tim Rupp (@caphrim007) ansible f5networks.f5_modules.bigip_profile_analytics – Manage HTTP analytics profiles on a BIG-IP f5networks.f5\_modules.bigip\_profile\_analytics – Manage HTTP analytics profiles on a BIG-IP ============================================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_profile_analytics`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage HTTP analytics profiles on a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| collect\_geo boolean \| Choices:* no * yes \| Enables or disables the collection of the names of the countries from where the traffic was sent. \| \| collect\_ip boolean \| Choices:* no * yes \| Enables or disables the collection of client IPs statistics. \| \| collect\_max\_tps\_and\_throughput boolean \| Choices:* no * yes \| Enables or disables the collection of maximum TPS and throughput for all collected entities. \| \| collect\_page\_load\_time boolean \| Choices:* no * yes \| Enables or disables the collection of the page load time statistics. \| \| collect\_url boolean \| Choices:* no * yes \| Enables or disables the collection of requested URL statistics. \| \| collect\_user\_agent boolean \| Choices:* no * yes \| Enables or disables the collection of user agents. \| \| collect\_user\_sessions boolean \| Choices:* no * yes \| Enables or disables the collection of the unique user sessions. \| \| collected\_stats\_external\_logging boolean \| Choices:* no * yes \| Enables or disables the external logging of the collected statistics. \| \| collected\_stats\_internal\_logging boolean \| Choices:* no * yes \| Enables or disables the internal logging of the collected statistics. \| \| description string \| \| Description of the profile. \| \| external\_logging\_publisher string \| \| Specifies the external logging publisher used to send statistical data to one or more destinations. \| \| name string / required \| \| Specifies the name of the profile. \| \| notification\_by\_email boolean \| Choices:* no * yes \| Enables or disables sending the analytics alerts by email. \| \| notification\_by\_syslog boolean \| Choices:* no * yes \| Enables or disables logging of the analytics alerts into the Syslog. \| \| notification\_email\_addresses list / elements=string \| \| Specifies which email addresses receive alerts by email when `notification_by_email` is enabled. \| \| parent string \| \| Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied `analytics` profile. \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * absent \| When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create a profile bigip_profile_analytics: name: profile1 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| param1 boolean \| changed \| The new param1 value of the resource. Sample: True \| \| param2 string \| changed \| The new param2 value of the resource. Sample: Foo is bar \| ### Authors * Tim Rupp (@caphrim007)	programming_docs
ansible f5networks.f5_modules.bigip_cgnat_lsn_pool – Manage CGNAT LSN Pools f5networks.f5\_modules.bigip\_cgnat\_lsn\_pool – Manage CGNAT LSN Pools ======================================================================= Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_cgnat_lsn_pool`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage CGNAT LSN (Large Scale NAT) Pools. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| backup\_members list / elements=string \| \| Specifies translation IP addresses available for backup members, which are used by Deterministic translation mode if `deterministic` mode translation fails and falls back to `napt` mode. This is a collection of IP prefixes with their prefix lengths. \| \| client\_conn\_limit integer \| \| Specifies the maximum number of simultaneous translated connections a client or subscriber is allowed to have. Valid range of values is between `0` and `4294967295` inclusive. \| \| description string \| \| User created LSN pool description. \| \| egress\_interfaces list / elements=string \| \| Specifies the set of interfaces on which the source address translation is allowed or disallowed, as determined by the `egress_intf_enabled` setting. \| \| egress\_intf\_enabled boolean \| Choices:* no * yes \| Specifies how the system handles address translation on the interfaces specified in `egress_interfaces`. When set to `yes`, source address translation is allowed only on the specified `egress_interfaces`. When set to `no`, source address translation is disabled on the specified `egress_interfaces`. \| \| harpin\_mode boolean \| Choices:* no * yes \| Enables or disables hairpinning for incoming connections to active translation end-points. \| \| icmp\_echo boolean \| Choices:* no * yes \| Enables or disables ICMP echo on translated addresses. \| \| inbound\_connections string \| Choices:* disabled * explicit * automatic \| Controls whether or not the BIG-IP system supports inbound connections for each outbound mapping. When `disabled`, system does not support inbound connections for outbound mappings, which prevents Port Control Protocol `pcp` from functioning. When `explicit`, the system supports inbound connections for explicit outbound mappings. When `automatic` the system supports inbound connections for every outbound mapping as it gets used. \| \| log\_profile string \| \| Specifies the name of the logging profile the pool uses. \| \| log\_publisher string \| \| Specifies the name of the log publisher that logs translation events. \| \| members list / elements=string \| \| Specifies the set of translation IP addresses available in the pool. This is a collection of IP prefixes with their prefix lengths. All public-side addresses come from the addresses in this group of subnets. Members of two or more deterministic LSN pools must not overlap. Every external address used for deterministic mapping must occur only in one LSN pool. \| \| mode string \| Choices:* napt * deterministic * pba \| Specifies the translation address mapping mode. The `napt` mode provides standard address and port translation allowing multiple clients in a private network to access remote networks using the single IP address assigned to their router. The `deterministic` address translation mode provides address translation that eliminates the logging of every address mapping, while still allowing internal client address tracking using only an external address and port, and a destination address and port. The `pba` mode logs the allocation and release of port blocks for subscriber translation requests, instead of separately logging each translation request. \| \| name string / required \| \| Specifies the name of the LSN pool to manage. \| \| partition string \| Default:"Common" \| Device partition on which to manage resources. \| \| pba\_block\_idle\_timeout integer \| \| Specifies the timeout duration subsequent to the point when the port block becomes idle. Valid range of values is between `0` and `4294967295` inclusive." \| \| pba\_block\_lifetime integer \| \| Specifies the timeout for the port block, after which the block is not used for new port allocations. Valid range of values is between `0` and `4294967295` inclusive. The value of `0` corresponds to an infinite timeout. \| \| pba\_block\_size integer \| \| Specifies the number of ports in a block. Valid range of values is between `0` and `65535` inclusive. The `pba_block_size` value should be less than or equal to the LSN pool range, i.e the range of ports defined by `port_range_low` and `port_range_high` values. \| \| pba\_client\_block\_limit integer \| \| Specifies the number of blocks that can be assigned to a single subscriber IP address. \| \| pba\_zombie\_timeout integer \| \| Specifies the timeout duration for a zombie port block, which is a timed out port block with one or more active connections. When the timeout duration expires, connections using the zombie block are killed and the zombie port block becomes an available port block. The value of `0` corresponds to an infinite timeout. System ignores this parameter value if `pba_block_lifetime` is `0`. \| \| persistence\_mode string \| Choices:* address * address-port * none \| Specifies the persistence settings for LSN translation entries. When `address`, the translation attempts to reuse the address mapping, but not the port mapping. When `address-port`, the translation attempts to reuse both the address and port mapping for subsequent packets sent from the same internal IP address and port. When `none`, peristence is disabled. \| \| persistence\_timeout integer \| \| Specifies the persistence timeout value for LSN translation entries. If a particular mapping is unused for this length of time, the mapping expires and the public-side address/port pair is free for use in other mappings. Valid range of values is between `0` and `31536000` inclusive. \| \| port\_range\_high integer \| \| Specifies the high end of the range of port numbers available for use with translation IP addresses. The `port_range_high` must always be higher or equal to `port_range_high` value. Valid range of values is between `0` and `65535` inclusive. \| \| port\_range\_low integer \| \| Specifies the low end of the range of port numbers available for use with translation IP addresses. The `port_range_low` must always be lower or equal to `port_range_high` value. Valid range of values is between `0` and `65535` inclusive. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| route\_advertisement boolean \| Choices:* no * yes \| Specifies whether the translation addresses are passed to the Advanced Routing Module for advertisement through dynamic routing protocols. \| \| state string \| Choices:* present ← * absent \| When `state` is `present`, ensures the LSN pool exists. When `state` is `absent`, ensures the LSN pool is removed. \| Notes ----- Note * Requires CGNAT is licensed and enabled on BIG-IP. * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Create an lsn pool bigip_cgnat_lsn_pool: name: foo mode: napt client_conn_limit: 100 log_profile: foo_profile log_publisher: foo_publisher members: - 10.1.1.0/24 provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Update lsn pool bigip_cgnat_lsn_pool: name: foo mode: pba pba_block_size: 128 pba_block_lifetime: 7200 pba_block_idle_timeout: 1800 pba_zombie_timeout: 900 log_profile: foo_profile log_publisher: foo_publisher provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost - name: Remove lsn pool bigip_cgnat_lsn_pool: name: foo state: absent provider: password: secret server: lb.mydomain.com user: admin delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| backup\_members list / elements=string \| changed \| The translation IP addresses available for backup members. Sample: ['/Common/10.10.10.0/24', '/Common/11.11.11.0/25'] \| \| client\_conn\_limit integer \| changed \| The maximum number of simultaneous translated connections a client or subscriber is allowed to have. Sample: 50 \| \| description string \| changed \| User created LSN pool description. Sample: some description \| \| egress\_interfaces list / elements=string \| changed \| The set of interfaces on which source address translation is allowed or disallowed. Sample: ['/Common/tunnel1', '/Common/tunnel2'] \| \| egress\_intf\_enabled boolean \| changed \| Specifies how the system handles address translation on the egress interfaces. \| \| harpin\_mode boolean \| changed \| Enables or disables hairpinning for incoming connections to active translation end-points. Sample: True \| \| icmp\_echo boolean \| changed \| Enables or disables ICMP echo on translated addresses. \| \| inbound\_connections string \| changed \| Controls BIG-IP system support of inbound connections for each outbound mapping. Sample: explicit \| \| log\_profile string \| changed \| The name of the logging profile the pool uses. Sample: /Common/foo\_log\_profile \| \| log\_publisher list / elements=string \| changed \| The name of the log publisher that logs translation events. Sample: /Common/publisher\_1 \| \| members list / elements=string \| changed \| The set of translation IP addresses available in the pool. Sample: ['/Common/10.10.10.0/24', '/Common/11.11.11.0/25'] \| \| mode string \| changed \| Specifies the translation address mapping mode. Sample: napt \| \| pba\_block\_idle\_timeout integer \| changed \| The timeout duration subsequent to the point when the port block becomes idle. Sample: 3600 \| \| pba\_block\_lifetime integer \| changed \| The timeout for the port block. Sample: 7200 \| \| pba\_block\_size integer \| changed \| The number of ports in a block. Sample: 128 \| \| pba\_client\_block\_limit integer \| changed \| The number of blocks that can be assigned to a single subscriber IP address. Sample: 3 \| \| pba\_zombie\_timeout integer \| changed \| The timeout duration for a zombie port block. Sample: 180 \| \| persistence\_mode string \| changed \| Specifies the persistence settings for LSN translation entries. Sample: address \| \| persistence\_timeout integer \| changed \| Specifies the persistence timeout value for LSN translation entries. Sample: 500 \| \| port\_range\_high integer \| changed \| The high end of the range of port numbers available for use with translation IP addresses. Sample: 65535 \| \| port\_range\_low integer \| changed \| The low end of the range of port numbers available for use with translation IP addresses. Sample: 1025 \| \| route\_advertisement boolean \| changed \| Specifies whether the translation addresses are advertised through dynamic routing protocols. Sample: True \| ### Authors * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_hostname – Manage the hostname of a BIG-IP f5networks.f5\_modules.bigip\_hostname – Manage the hostname of a BIG-IP ======================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_hostname`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage the hostname of a BIG-IP device. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| hostname string / required \| \| Hostname of the BIG-IP host. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set the hostname of the BIG-IP bigip_hostname: hostname: bigip.localhost.localdomain provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| hostname string \| changed \| The new hostname of the device. Sample: big-ip01.internal \| ### Authors * Tim Rupp (@caphrim007) * Matthew Lam (@mryanlam) * Wojciech Wypior (@wojtek0806) ansible f5networks.f5_modules.bigip_virtual_server – Manage LTM virtual servers on a BIG-IP f5networks.f5\_modules.bigip\_virtual\_server – Manage LTM virtual servers on a BIG-IP ====================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_virtual_server`. New in version 1.0.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage LTM virtual servers on a BIG-IP system. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address\_translation boolean \| Choices:* no * yes \| When `enabled`, specifies the system translates the address of the virtual server. When `disabled`, specifies the system uses the address without translation. This option is useful when the system is load balancing devices that have the same IP address. When creating a new virtual server, the default is `enabled`. \| \| bypass\_module\_checks boolean added in 1.3.0 of f5networks.f5\_modules \| Choices:* no ← * yes \| Disables all built-in module verification checks that require BIG-IP device calls. Using this option cuts down on the number of REST calls made by this module. The trade off is that most parameters are sent as is, which requires extra care when defining them. The device is the final source of truth for such configurations, usable in cases where speed is preferred over accuracy. If set to `yes`, the module ignores the value op `check_profiles` parameter. This parameter can be used when creating new or updating existing resources. \| \| check\_profiles boolean added in 1.2.0 of f5networks.f5\_modules \| Choices:* no * yes ← \| Specifies whether the client and server SSL profiles specified by the user should be verified to be correct against the existing profiles. This is useful in cases where a large number of profiles are being added at once. Not recommended for common use. In case of duplicate profiles, or erroneous profiles, the BIG-IP throws an error. \| \| clone\_pools list / elements=dictionary \| \| Specifies a pool or list of pools that the virtual server uses to replicate either client-side or server-side traffic. Typically this option is used for intrusion detection. \| \| \| context string / required \| Choices:* clientside * serverside \| The context option for a clone pool to replicate either client-side or server-side traffic. \| \| \| pool\_name string / required \| \| The pool name to which the server replicates the traffic. Only pools created on the Common partition or on the same partition as the virtual server can be used. Referencing a pool on the Common partition needs to be done in the full path format, for example, `/Common/pool_name`. \| \| default\_persistence\_profile string \| \| Default profile which manages the session persistence. If you want to remove the existing default persistence profile, specify an empty value; `""`. See the documentation for an example. When `type` is `dhcp`, this parameter is ignored. \| \| description string \| \| Virtual server description. \| \| destination string \| \| Destination IP of the virtual server. Required when `state` is `present` and the virtual server does not exist. When `type` is `internal`, this parameter is ignored. For all other types, it is required. Destination can also be specified as a name for an existing Virtual Address. aliases: address, ip \| \| disabled\_vlans list / elements=string \| \| List of VLANs to be disabled. If the partition is not specified in the VLAN, the `partition` option of this module is used. This parameter is mutually exclusive with the `enabled_vlans` parameters. \| \| enabled\_vlans list / elements=string \| \| List of VLANs to enable. When a VLAN named `all` is used, all VLANs will be allowed. VLANs can be specified with or without the leading partition. If the partition is not specified in the VLAN, the `partition` option of this module is used. This parameter is mutually exclusive with the `disabled_vlans` parameter. \| \| fallback\_persistence\_profile string \| \| Specifies the persistence profile you want the system to use if it cannot use the specified default persistence profile. If you want to remove the existing fallback persistence profile, specify an empty value; `""`. See the documentation for an example. When `type` is `dhcp`, this parameter is ignored. \| \| firewall\_enforced\_policy string \| \| Applies the specified AFM policy to the virtual in an enforcing way. When creating a new virtual, if this parameter is not specified, the enforced policy is disabled. \| \| firewall\_staged\_policy string \| \| Applies the specified AFM policy to the virtual in an enforcing way. A staged policy shows the results of the policy rules in the log, while not actually applying the rules to traffic. When creating a new virtual, if this parameter is not specified, the staged policy is disabled. \| \| insert\_metadata boolean \| Choices:* no * yes ← \| When set to `no`, the module does not set metadata on the device. Currently there is a limitation that non-admin users cannot set metadata on the object, despite being able to create and modify virtual server objects. Setting this option to `no` allows such users to use this module to manage virtual server objects on the device. Attempting to change `state` on Virtual Server that belongs to an iAPP with strict updates enabled will result in error message returned by device, unless `insert_metadata` parameter is set to `no`. \| \| ip\_intelligence\_policy string \| \| Specifies the IP intelligence policy applied to the virtual server. This parameter requires a valid BIG-IP security module is provisioned, such as ASM or AFM. \| \| ip\_protocol string \| Choices:* ah * any * bna * esp * etherip * gre * icmp * ipencap * ipv6 * ipv6-auth * ipv6-crypt * ipv6-icmp * isp-ip * mux * ospf * sctp * tcp * udp * udplite \| Specifies a network protocol name you want the system to use to direct traffic on this virtual server. When creating a new virtual server, if this parameter is not specified, the default is `tcp`. The Protocol setting is not available when you select Performance (HTTP) as the `Type`. The value of this argument can be specified in either its numeric value, or in a select number of named values. Refer to `choices` for examples. For a list of valid IP protocol numbers, refer to https://en.wikipedia.org/wiki/List\_of\_IP\_protocol\_numbers. When `type` is `dhcp`, this module forces the `ip_protocol` parameter to `17` (UDP). \| \| irules list / elements=string \| \| Specifies a list of rules to be applied in priority order. If you want to remove existing iRules, specify a single empty value; `""`. See the documentation for an example. The order in which iRules are specified does matter, so a list that contains the same list elements but in a different order in the playbook will make changes on the device. When `type` is `dhcp`, `stateless`, `reject`, or `internal`, this parameter is ignored. aliases: all\_rules \| \| mask string \| \| Specifies the destination address network mask. This parameter works with IPv4 and IPv6 addresses. This is an optional parameter which can be specified when creating or updating virtual server. If `destination` is set in CIDR notation format and `mask` is provided, the `mask` parameter takes precedence. If you specify a catchall destination (for example, `0.0.0.0` for IPv4, `::` for IPv6) the mask parameter is set to `any` or `any6` respectively. When the `destination` is not in CIDR notation and a `mask` is not specified, `255.255.255.255` or `ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff` is set for IPv4 and IPv6 addresses respectively. When `destination` is provided in CIDR notation format and a `mask` is not specified, the mask parameter is inferred from `destination`. When `destination` is provided as a virtual address name, and a `mask` is not specified, the mask will be `None`, allowing device set it with its internal defaults. \| \| metadata raw \| \| Arbitrary key/value pairs you can attach to a virtual server. This is useful in situations where you want to annotate a virtual to be managed by Ansible. Key names are stored as strings; this includes names that are numbers. Values for all of the keys are stored as strings; this includes values that are numbers. Data is persisted, not ephemeral. \| \| mirror boolean \| Choices:* no * yes \| Specifies the system mirrors connections on each member of a redundant pair. When creating a new virtual server, if this parameter is not specified, the default is `disabled`. \| \| name string / required \| \| Virtual server name. aliases: vs \| \| partition string \| Default:"Common" \| Device partition to manage resources on. \| \| policies list / elements=string \| \| Specifies the policies for the virtual server. When `type` is `dhcp`, `reject`, or `internal`, this parameter is ignored. aliases: all\_policies \| \| pool string \| \| Default pool for the virtual server. If you want to remove the existing pool, specify an empty value; `""`. See the documentation for an example. When creating a new virtual server, and `type` is `stateless`, this parameter is required. If `type` is `stateless`, the `pool` must not have any members which define a `rate_limit`. \| \| port string \| \| Port of the virtual server. Required when `state` is `present` and the virtual server does not exist. If you do not want to specify a particular port, use the value `0`. This means the virtual server listens on any port. When `type` is `dhcp`, this module forces the `port` parameter to `67`. When `type` is `internal`, this module forces the `port` parameter to `0`. In addition to specifying a port number, a select number of service names may also be provided. The string `ftp` may be substituted for for port `21`. The string `http` may be substituted for for port `80`. The string `https` may be substituted for for port `443`. The string `telnet` may be substituted for for port `23`. The string `smtp` may be substituted for for port `25`. The string `snmp` may be substituted for for port `161`. The string `snmp-trap` may be substituted for for port `162`. The string `ssh` may be substituted for for port `22`. The string `tftp` may be substituted for for port `69`. The string `isakmp` may be substituted for for port `500`. The string `mqtt` may be substituted for for port `1883`. The string `mqtt-tls` may be substituted for for port `8883`. \| \| port\_translation boolean \| Choices:* no * yes \| When `enabled`, specifies the system translates the port of the virtual server. When `disabled`, specifies the system uses the port without translation. Turning off port translation for a virtual server is useful if you want to use the virtual server to load balance connections to any service. When creating a new virtual server, the default is `enabled`. \| \| profiles raw \| \| List of profiles (HTTP, ClientSSL, ServerSSL, etc) to apply to both sides of the connection (client-side and server-side). If you only want to apply a particular profile to the client-side of the connection, specify `client-side` for the profile's `context`. If you only want to apply a particular profile to the server-side of the connection, specify `server-side` for the profile's `context`. If `context` is not provided, it will default to `all`. If you want to remove a profile from the list of profiles currently active on the virtual, simply remove it from the `profiles` list. See examples for an illustration of this. If you want to add a profile to the list of profiles currently active on the virtual, simply add it to the `profiles` list. See examples for an illustration of this. Profiles are important. This module will fail to configure a BIG-IP if you mix up your profiles, or if you attempt to set an IP protocol which your current, or new, profiles do not support. Both this module, and BIG-IP, will report an error if this is incorrect, resembling `lists profiles incompatible with its protocol`. If you are unsure what the correct profile combinations are, we suggest having a BIG-IP available in which you can make changes and copy what the correct combinations are. To use `http2` in full proxy to enable `HTTP MRF Router` option seen in the GUI you need to assign `/Common/httprouter` profile with `context` set to `all`. See the bottom of examples section below. aliases: all\_profiles \| \| \| context string \| Choices:* all ← * server-side * client-side \| The side of the connection on which the profile should be applied. \| \| \| name string \| \| Name of the profile. This must be specified if a context is specified. If this is not specified, it is assumed the profile item is only a name of a profile. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| rate\_limit integer \| \| Virtual server rate limit (connections-per-second). Setting this to `0` disables the limit. The valid value range is `0` - `4294967295`. \| \| rate\_limit\_dst\_mask integer \| \| Specifies a mask, in bits, to be applied to the destination address as part of the rate limiting. The default value is `0`, which is equivalent to using the entire address - `32` in IPv4, or `128` in IPv6. The valid value range is `0` - `4294967295`. \| \| rate\_limit\_mode string \| Choices:* object ← * object-source * object-destination * object-source-destination * destination * source * source-destination \| Indicates whether the rate limit is applied per virtual object, per source address, per destination address, or some combination thereof. The default value is `object`, which does not use the source or destination address as part of the key. \| \| rate\_limit\_src\_mask integer \| \| Specifies a mask, in bits, to be applied to the source address as part of the rate limiting. The default value is `0`, which is equivalent to using the entire address - `32` in IPv4, or `128` in IPv6. The valid value range is `0` - `4294967295`. \| \| security\_log\_profiles list / elements=string \| \| Specifies the log profile applied to the virtual server. To make use of this feature, the AFM module must be licensed and provisioned. The `Log all requests` and `Log illegal requests` are mutually exclusive and therefore, this module raises an error if the two are specified together. \| \| security\_nat\_policy dictionary \| \| Specify the Firewall NAT policies for the virtual server. You can specify one or more NAT policies to use. The most specific policy is used. For example, if you specify the virtual server should use the device policy and the route domain policy, the route domain policy overrides the device policy. \| \| \| policy string \| \| Specifies the policy to apply a NAT policy directly to the virtual server. The virtual server NAT policy is the most specific, and overrides a route domain and device policy, if specified. To remove the policy, specify an empty string value. \| \| \| use\_device\_policy boolean \| Choices:* no * yes \| Specifies the virtual server uses the device NAT policy, as specified in the Firewall Options. The device policy is used if no route domain or virtual server NAT setting is specified. \| \| \| use\_route\_domain\_policy boolean \| Choices:* no * yes \| Specifies the virtual server uses the route domain policy, as specified in the Route Domain Security settings. When specified, the route domain policy overrides the device policy, and is overridden by a virtual server policy. \| \| snat string \| \| Source network address policy. When `type` is `dhcp`, `reject`, or `internal`, this parameter is ignored. The name of a SNAT pool (like "/Common/snat\_pool\_name") can be specified to enable SNAT with the specific pool. To remove SNAT, specify the word `none`. To specify automap, use the word `automap`. \| \| source string \| \| Specifies an IP address or network from which the virtual server accepts traffic. The virtual server accepts clients only from one of these IP addresses. For this setting to function effectively, specify a value other than 0.0.0.0/0 or ::/0 (that is, any/0, any6/0). In order to maximize the utility of this setting, specify the most specific address prefixes covering all customer addresses and no others. Specify the IP address in Classless Inter-Domain Routing (CIDR) format; address/prefix, where the prefix length is in bits. For example, for IPv4, 10.0.0.1/32 or 10.0.0.0/24, and for IPv6, ffe1::0020/64 or 2001:ed8:77b5:2:10:10:100:42/64. \| \| source\_port string \| Choices:* preserve * preserve-strict * change \| Specifies whether the system preserves the source port of the connection. When creating a new virtual server, if this parameter is not specified, the default is `preserve`. \| \| state string \| Choices:* present ← * absent * enabled * disabled \| The virtual server state. If `absent`, deletes the virtual server if it exists. If `present`, creates the virtual server and enables it. If `enabled`, enables the virtual server if it exists. If `disabled`, creates the virtual server if needed, and sets the state to `disabled`. Attempting to change `state` on a virtual server that belongs to an iAPP with strict updates enabled will result in an error message returned by device, unless `insert_metadata` parameter is set to `no`. \| \| type string \| Choices:* standard ← * forwarding-l2 * forwarding-ip * performance-http * performance-l4 * stateless * reject * dhcp * internal * message-routing \| Specifies the network service provided by this virtual server. When creating a new virtual server, if this parameter is not provided, the default is `standard`. This value cannot be changed after it is set. When `standard`, specifies a virtual server that directs client traffic to a load balancing pool, and is the most basic type of virtual server. When you first create the virtual server, you assign an existing default pool to it. From then on, the virtual server automatically directs traffic to that default pool. When `forwarding-l2`, specifies a virtual server that shares the same IP address as a node in an associated VLAN. When `forwarding-ip`, specifies a virtual server like other virtual servers, except the virtual server has no pool members to load balance. The virtual server simply forwards the packet directly to the destination IP address specified in the client request. When `performance-http`, specifies a virtual server with which you associate a Fast HTTP profile. Together, the virtual server and profile increase the speed at which the virtual server processes HTTP requests. When `performance-l4`, specifies a virtual server with which you associate a Fast L4 profile. Together, the virtual server and profile increase the speed at which the virtual server processes layer 4 requests. When `stateless`, specifies a virtual server that accepts traffic matching the virtual server address and load balances the packet to the pool members without attempting to match the packet to a pre-existing connection in the connection table. New connections are immediately removed from the connection table. This addresses the requirement for one-way UDP traffic that needs to be processed at very high throughput levels, for example, load balancing syslog traffic to a pool of syslog servers. Stateless virtual servers are not suitable for processing traffic requiring stateful tracking, such as TCP traffic. Stateless virtual servers do not support iRules, persistence, connection mirroring, rateshaping, or SNAT automap. When `reject`, specifies the BIG-IP system rejects any traffic destined for the virtual server IP address. When `dhcp`, specifies a virtual server that relays Dynamic Host Control Protocol (DHCP) client requests for an IP address to one or more DHCP servers, and provides DHCP server responses with an available IP address for the client. When `internal`, specifies a virtual server that supports modification of HTTP requests and responses. Internal virtual servers enable the use of ICAP (Internet Content Adaptation Protocol) servers to modify HTTP requests and responses by creating and applying an ICAP profile and adding Request Adapt or Response Adapt profiles to the virtual server. When `message-routing`, specifies a virtual server that uses a SIP application protocol and functions in accordance with a SIP session profile and SIP router profile. \| Notes ----- Note * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Modify Port of the Virtual Server bigip_virtual_server: state: present partition: Common name: my-virtual-server port: 8080 provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Delete virtual server bigip_virtual_server: state: absent partition: Common name: my-virtual-server provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Add virtual server bigip_virtual_server: state: present partition: Common name: my-virtual-server destination: 10.10.10.10 port: 443 pool: my-pool snat: Automap description: Test Virtual Server profiles: - http - fix - name: clientssl context: server-side - name: ilx context: client-side policies: - my-ltm-policy-for-asm - ltm-uri-policy - ltm-policy-2 - ltm-policy-3 enabled_vlans: - /Common/vlan2 provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Add FastL4 virtual server bigip_virtual_server: destination: 1.1.1.1 name: fastl4_vs port: 80 profiles: - fastL4 state: present provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Add iRules to the Virtual Server bigip_virtual_server: name: my-virtual-server irules: - irule1 - irule2 provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Remove one iRule from the Virtual Server bigip_virtual_server: name: my-virtual-server irules: - irule2 provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Remove all iRules from the Virtual Server bigip_virtual_server: name: my-virtual-server irules: "" provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Remove pool from the Virtual Server bigip_virtual_server: name: my-virtual-server pool: "" provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Add metadata to virtual bigip_virtual_server: name: my-virtual-server partition: Common metadata: ansible: 2.4 updated_at: 2017-12-20T17:50:46Z provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add virtual with two profiles bigip_virtual_server: name: my-virtual-server partition: Common profiles: - http - tcp provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Remove HTTP profile from previous virtual bigip_virtual_server: name: my-virtual-server partition: Common profiles: - tcp provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add the HTTP profile back to the previous virtual bigip_virtual_server: name: my-virtual-server partition: Common profiles: - http - tcp provider: server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add virtual server with rate limit bigip_virtual_server: state: present partition: Common name: my-virtual-server destination: 10.10.10.10 port: 443 pool: my-pool snat: Automap description: Test Virtual Server profiles: - http - fix - name: clientssl context: server-side - name: ilx context: client-side policies: - my-ltm-policy-for-asm - ltm-uri-policy - ltm-policy-2 - ltm-policy-3 enabled_vlans: - /Common/vlan2 rate_limit: 400 rate_limit_mode: destination rate_limit_dst_mask: 32 provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Add FastL4 virtual server with clone_pools bigip_virtual_server: destination: 1.1.1.1 name: fastl4_vs port: 80 profiles: - fastL4 state: present clone_pools: - pool_name: FooPool context: clientside provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost - name: Add virtual with MRF router option set bigip_virtual_server: name: my-virtual-server destination: 10.10.10.10 port: 443 partition: Common profiles: - http - tcp - name: noneg-ssl context: client-side - name: http2 context: client-side - name: httprouter context: all provider: server: lb.mydomain.net user: admin password: secret delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address\_translation boolean \| changed \| The new value specifying whether address translation is on or off. Sample: True \| \| clone\_pools list / elements=string \| changed \| Pools to which virtual server copies traffic. Sample: [{'context': 'clientside', 'pool\_name': '/Common/Pool1'}] \| \| default\_persistence\_profile string \| changed \| Default persistence profile set on the virtual server. Sample: /Common/dest\_addr \| \| description string \| changed \| New description of the virtual server. Sample: This is my description \| \| destination string \| changed \| Destination of the virtual server. Sample: 1.1.1.1 \| \| disabled boolean \| changed \| Whether the virtual server is disabled or not. Sample: True \| \| disabled\_vlans list / elements=string \| changed \| List of VLANs that the virtual is disabled for. Sample: ['/Common/vlan1', '/Common/vlan2'] \| \| enabled boolean \| changed \| Whether the virtual server is enabled or not. \| \| enabled\_vlans list / elements=string \| changed \| List of VLANs that the virtual is enabled for. Sample: ['/Common/vlan5', '/Common/vlan6'] \| \| fallback\_persistence\_profile string \| changed \| Fallback persistence profile set on the virtual server. Sample: /Common/source\_addr \| \| firewall\_enforced\_policy string \| changed \| The new enforcing firewall policy. Sample: /Common/my-enforced-fw \| \| firewall\_staged\_policy string \| changed \| The new staging firewall policy. Sample: /Common/my-staged-fw \| \| ip\_intelligence\_policy string \| changed \| The new IP Intelligence Policy assigned to the virtual. Sample: /Common/ip-intelligence \| \| ip\_protocol integer \| changed \| The new value of the IP protocol. Sample: 6 \| \| irules list / elements=string \| changed \| iRules set on the virtual server. Sample: ['/Common/irule1', '/Common/irule2'] \| \| metadata dictionary \| changed \| The new value of the virtual. Sample: {'key1': 'foo', 'key2': 'bar'} \| \| mirror boolean \| changed \| Specifies the system mirrors connections on each member of a redundant pair. Sample: True \| \| policies list / elements=string \| changed \| List of policies attached to the virtual. Sample: ['/Common/policy1', '/Common/policy2'] \| \| pool string \| changed \| Pool the virtual server is attached to. Sample: /Common/my-pool \| \| port integer \| changed \| Port the virtual server is configured to listen on. Sample: 80 \| \| port\_translation boolean \| changed \| The new value specifying whether port translation is on or off. Sample: True \| \| profiles list / elements=string \| changed \| List of profiles set on the virtual server. Sample: [{'context': 'server-side', 'name': 'tcp'}, {'context': 'client-side', 'name': 'tcp-legacy'}] \| \| rate\_limit integer \| changed \| The maximum number of connections per second allowed for a virtual server. Sample: 5000 \| \| rate\_limit\_dst\_mask integer \| changed \| Specifies a mask, in bits, to be applied to the destination address as part of the rate limiting. Sample: 32 \| \| rate\_limit\_mode string \| changed \| Sets the type of rate limiting to be used on the virtual server. Sample: object-source \| \| rate\_limit\_src\_mask integer \| changed \| Specifies a mask, in bits, to be applied to the source address as part of the rate limiting. Sample: 32 \| \| security\_log\_profiles list / elements=string \| changed \| The new list of security log profiles. Sample: ['/Common/profile1', '/Common/profile2'] \| \| snat string \| changed \| SNAT setting of the virtual server. Sample: Automap \| \| source string \| changed \| Source address set on the virtual server, in CIDR format. Sample: 1.2.3.4/32 \| \| source\_port string \| changed \| Specifies whether the system preserves the source port of the connection. Sample: change \| ### Authors * Tim Rupp (@caphrim007) * Wojciech Wypior (@wojtek0806) * Nitin Khanna (@nitinthewiz)	programming_docs
ansible f5networks.f5_modules.bigip_asm_advanced_settings – Manage BIG-IP system ASM advanced settings f5networks.f5\_modules.bigip\_asm\_advanced\_settings – Manage BIG-IP system ASM advanced settings ================================================================================================== Note This plugin is part of the [f5networks.f5\_modules collection](https://galaxy.ansible.com/f5networks/f5_modules) (version 1.12.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 f5networks.f5_modules`. To use it in a playbook, specify: `f5networks.f5_modules.bigip_asm_advanced_settings`. New in version 1.4.0: of f5networks.f5\_modules * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage BIG-IP system ASM advanced settings. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| name string / required \| \| The ASM setting to manipulate. \| \| provider dictionary added in 1.0.0 of f5networks.f5\_modules \| \| A dict object containing connection details. \| \| \| auth\_provider string \| \| Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. \| \| \| no\_f5\_teem boolean \| Choices:* no ← * yes \| If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. \| \| \| password string / required \| \| The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd \| \| \| server string / required \| \| The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`. \| \| \| server\_port integer \| Default:443 \| The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. \| \| \| timeout integer \| \| Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. \| \| \| transport string \| Choices:* rest ← \| Configures the transport connection to use when connecting to the remote device. \| \| \| user string / required \| \| The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`. \| \| \| validate\_certs boolean \| Choices:* no * yes ← \| If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`. \| \| state string \| Choices:* present ← * reset \| The state of the setting on the system. When `present`, guarantees that an existing setting is set to `value`. When `reset`, sets the setting back to the default value. At least one of value and state `reset` are required. \| \| value string \| \| The value to set the key to. At least one of value and state `reset` are required. \| Notes ----- Note * Requires BIG-IP version 12.0.0 or greater * For more information on using Ansible to manage F5 Networks devices see <https://www.ansible.com/integrations/networks/f5>. * Requires BIG-IP software version >= 12. * The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the [f5networks.f5\_modules.bigip\_config](bigip_config_module#ansible-collections-f5networks-f5-modules-bigip-config-module) module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration. Examples -------- ``` - name: Set the long_request_buffer_size asm setting bigip_asm_advanced_settings: name: long_request_buffer_size value: 20000000 provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost - name: Reset the long_request_buffer_size to default value bigip_asm_advanced_settings: name: long_request_buffer_size state: reset provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| default\_value string \| changed and success \| The default value of the specified ASM setting Sample: 10000000 \| \| name string \| changed and success \| The name of the ASM setting that was specified Sample: long\_request\_buffer\_size \| \| value string \| changed and success \| The value you set the ASM setting to Sample: 20000000 \| ### Authors * Wojciech Wypior (@wojtek0806) ansible Collections in the Google Namespace Collections in the Google Namespace =================================== These are the collections with docs hosted on [docs.ansible.com](https://docs.ansible.com/) in the google namespace. * [google.cloud](cloud/index#plugins-in-google-cloud) ansible google.cloud.gcp_iam_service_account_info – Gather info for GCP ServiceAccount google.cloud.gcp\_iam\_service\_account\_info – Gather info for GCP ServiceAccount ================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_iam_service_account_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP ServiceAccount Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a service account gcp_iam_service_account_info: project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| displayName string \| success \| User specified description of service account. \| \| \| email string \| success \| Email address of the service account. \| \| \| name string \| success \| The name of the service account. \| \| \| oauth2ClientId string \| success \| OAuth2 client id for the service account. \| \| \| projectId string \| success \| Id of the project that owns the service account. \| \| \| uniqueId string \| success \| Unique and stable id of the service account. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_pubsub_topic_info – Gather info for GCP Topic google.cloud.gcp\_pubsub\_topic\_info – Gather info for GCP Topic ================================================================= Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_pubsub_topic_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP Topic Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a topic gcp_pubsub_topic_info: project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| kmsKeyName string \| success \| The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. Your project's PubSub service account (`service-{{PROJECT\_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com`) must have `roles/cloudkms.cryptoKeyEncrypterDecrypter` to use this feature. The expected format is `projects/\/locations/\/keyRings/\/cryptoKeys/\` . \| \| \| labels dictionary \| success \| A set of key/value label pairs to assign to this Topic. \| \| \| messageStoragePolicy complex \| success \| Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect. \| \| \| \| allowedPersistenceRegions list / elements=string \| success \| A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration. \| \| \| name string \| success \| Name of the topic. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_global_address – Creates a GCP GlobalAddress google.cloud.gcp\_compute\_global\_address – Creates a GCP GlobalAddress ======================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_global_address`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Represents a Global Address resource. Global addresses are used for HTTP(S) load balancing. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| The static external IP address represented by this resource. \| \| address\_type string \| Default:"EXTERNAL" \| The type of the address to reserve. \* EXTERNAL indicates public/external single IP address. \* INTERNAL indicates internal IP ranges belonging to some network. Some valid choices include: "EXTERNAL", "INTERNAL" \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| description string \| \| An optional description of this resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| ip\_version string \| \| The IP Version that will be used by this address. The default value is `IPV4`. Some valid choices include: "IPV4", "IPV6" \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| network* dictionary \| \| The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address. This field represents a link to a Network resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_network task and then set this network field to "{{ name-of-resource }}" \| \| prefix\_length integer \| \| The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=EXTERNAL. \| \| project string \| \| The Google Cloud Platform project to use. \| \| purpose string \| \| The purpose of the resource. For global internal addresses it can be \* VPC\_PEERING - for peer networks This should only be set when using an Internal address. Some valid choices include: "VPC\_PEERING" \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/v1/globalAddresses> * Reserving a Static External IP Address: <https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a global address google.cloud.gcp_compute_global_address: name: test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address string \| success \| The static external IP address represented by this resource. \| \| addressType string \| success \| The type of the address to reserve. \* EXTERNAL indicates public/external single IP address. \* INTERNAL indicates internal IP ranges belonging to some network. \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. \| \| id integer \| success \| The unique identifier for the resource. This identifier is defined by the server. \| \| ipVersion string \| success \| The IP Version that will be used by this address. The default value is `IPV4`. \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| network* dictionary \| success \| The URL of the network in which to reserve the IP range. The IP range must be in RFC1918 space. The network cannot be deleted if there are any reserved IP ranges referring to it. This should only be set when using an Internal address. \| \| prefixLength integer \| success \| The prefix length of the IP range. If not present, it means the address field is a single IP address. This field is not applicable to addresses with addressType=EXTERNAL. \| \| purpose string \| success \| The purpose of the resource. For global internal addresses it can be \* VPC\_PEERING - for peer networks This should only be set when using an Internal address. \| \| region string \| success \| A reference to the region where the regional address resides. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_runtimeconfig_config – Creates a GCP Config google.cloud.gcp\_runtimeconfig\_config – Creates a GCP Config ============================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_runtimeconfig_config`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig service. * A RuntimeConfig resource consists of metadata and a hierarchy of variables. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| description string \| \| The description to associate with the runtime config. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| name string / required \| \| The name of the runtime config. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| Examples -------- ``` - name: create a config google.cloud.gcp_runtimeconfig_config: name: test_object description: My config project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| success \| The description to associate with the runtime config. \| \| name string \| success \| The name of the runtime config. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_network – Creates a GCP Network google.cloud.gcp\_compute\_network – Creates a GCP Network ========================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_network`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manages a VPC network or legacy network resource on GCP. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| auto\_create\_subnetworks boolean \| Choices:* no * yes \| When set to `true`, the network is created in "auto subnet mode" and it will create a subnet for each region automatically across the `10.128.0.0/9` address range. When set to `false`, the network is created in "custom subnet mode" so the user can explicitly connect subnetwork resources. \| \| description string \| \| An optional description of this resource. The resource must be recreated to modify this field. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| mtu integer \| \| Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| project* string \| \| The Google Cloud Platform project to use. \| \| routing\_config dictionary \| \| The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. \| \| \| routing\_mode string / required \| \| The network-wide routing mode to use. If set to `REGIONAL`, this network's cloud routers will only advertise routes with subnetworks of this network in the same region as the router. If set to `GLOBAL`, this network's cloud routers will advertise routes with all subnetworks of this network, across regions. Some valid choices include: "REGIONAL", "GLOBAL" \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/rest/v1/networks> * Official Documentation: <https://cloud.google.com/vpc/docs/vpc> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a network google.cloud.gcp_compute_network: name: test_object auto_create_subnetworks: 'true' project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| autoCreateSubnetworks boolean \| success \| When set to `true`, the network is created in "auto subnet mode" and it will create a subnet for each region automatically across the `10.128.0.0/9` address range. When set to `false`, the network is created in "custom subnet mode" so the user can explicitly connect subnetwork resources. \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. The resource must be recreated to modify this field. \| \| gateway\_ipv4 string \| success \| The gateway address for default routing out of the network. This value is selected by GCP. \| \| id integer \| success \| The unique identifier for the resource. \| \| mtu integer \| success \| Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| routingConfig* complex \| success \| The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. \| \| \| routingMode string \| success \| The network-wide routing mode to use. If set to `REGIONAL`, this network's cloud routers will only advertise routes with subnetworks of this network in the same region as the router. If set to `GLOBAL`, this network's cloud routers will advertise routes with all subnetworks of this network, across regions. \| \| subnetworks list / elements=string \| success \| Server-defined fully-qualified URLs for all subnetworks in this network. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_resource_policy_info – Gather info for GCP ResourcePolicy google.cloud.gcp\_compute\_resource\_policy\_info – Gather info for GCP ResourcePolicy ====================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_resource_policy_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP ResourcePolicy Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| region string / required \| \| Region where resource policy resides. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a resource policy gcp_compute_resource_policy_info: region: us-central1 filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| groupPlacementPolicy complex \| success \| Policy for creating snapshots of persistent disks. \| \| \| \| availabilityDomainCount integer \| success \| The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network . \| \| \| \| collocation string \| success \| Collocation specifies whether to place VMs inside the same availability domain on the same low-latency network. Specify `COLLOCATED` to enable collocation. Can only be specified with `vm\_count`. If compute instances are created with a COLLOCATED policy, then exactly `vm\_count` instances must be created at the same time with the resource policy attached. \| \| \| \| vmCount integer \| success \| Number of vms in this placement group. \| \| \| name string \| success \| The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])`? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| region* string \| success \| Region where resource policy resides. \| \| \| snapshotSchedulePolicy complex \| success \| Policy for creating snapshots of persistent disks. \| \| \| \| retentionPolicy complex \| success \| Retention policy applied to snapshots created by this resource policy. \| \| \| \| \| maxRetentionDays integer \| success \| Maximum age of the snapshot that is allowed to be kept. \| \| \| \| \| onSourceDiskDelete string \| success \| Specifies the behavior to apply to scheduled snapshots when the source disk is deleted. \| \| \| \| schedule complex \| success \| Contains one of an `hourlySchedule`, `dailySchedule`, or `weeklySchedule`. \| \| \| \| \| dailySchedule complex \| success \| The policy will execute every nth day at the specified time. \| \| \| \| \| \| daysInCycle integer \| success \| The number of days between snapshots. \| \| \| \| \| \| startTime string \| success \| This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid. \| \| \| \| \| hourlySchedule complex \| success \| The policy will execute every nth hour starting at the specified time. \| \| \| \| \| \| hoursInCycle integer \| success \| The number of hours between snapshots. \| \| \| \| \| \| startTime string \| success \| Time within the window to start the operations. It must be in an hourly format "HH:MM", where HH : [00-23] and MM : [00] GMT. eg: 21:00 . \| \| \| \| \| weeklySchedule complex \| success \| Allows specifying a snapshot time for each day of the week. \| \| \| \| \| \| dayOfWeeks complex \| success \| May contain up to seven (one for each day of the week) snapshot times. \| \| \| \| \| \| \| day string \| success \| The day of the week to create the snapshot. e.g. MONDAY . \| \| \| \| \| \| \| startTime string \| success \| Time within the window to start the operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-00] GMT. \| \| \| \| snapshotProperties complex \| success \| Properties with which the snapshots are created, such as labels. \| \| \| \| \| guestFlush boolean \| success \| Whether to perform a 'guest aware' snapshot. \| \| \| \| \| labels dictionary \| success \| A set of key-value pairs. \| \| \| \| \| storageLocations list / elements=string \| success \| Cloud Storage bucket location to store the auto snapshot (regional or multi-regional) . \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_http_health_check_info – Gather info for GCP HttpHealthCheck google.cloud.gcp\_compute\_http\_health\_check\_info – Gather info for GCP HttpHealthCheck ========================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_http_health_check_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP HttpHealthCheck Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a HTTP health check gcp_compute_http_health_check_info: filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| checkIntervalSec integer \| success \| How often (in seconds) to send a health check. The default value is 5 seconds. \| \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| \| description string \| success \| An optional description of this resource. Provide this property when you create the resource. \| \| \| healthyThreshold integer \| success \| A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. \| \| \| host string \| success \| The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. \| \| \| id integer \| success \| The unique identifier for the resource. This identifier is defined by the server. \| \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| port* integer \| success \| The TCP port number for the HTTP health check request. The default value is 80. \| \| \| requestPath string \| success \| The request path of the HTTP health check request. The default value is /. \| \| \| timeoutSec integer \| success \| How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. \| \| \| unhealthyThreshold integer \| success \| A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_compute_http_health_check – Creates a GCP HttpHealthCheck google.cloud.gcp\_compute\_http\_health\_check – Creates a GCP HttpHealthCheck ============================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_http_health_check`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| check\_interval\_sec integer \| Default:"5" \| How often (in seconds) to send a health check. The default value is 5 seconds. aliases: check\_interval\_seconds \| \| description string \| \| An optional description of this resource. Provide this property when you create the resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| healthy\_threshold integer \| \| A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. \| \| host string \| \| The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| port* integer \| \| The TCP port number for the HTTP health check request. The default value is 80. \| \| project string \| \| The Google Cloud Platform project to use. \| \| request\_path string \| \| The request path of the HTTP health check request. The default value is /. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| timeout\_sec integer \| \| How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. aliases: timeout\_seconds \| \| unhealthy\_threshold integer \| \| A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/v1/httpHealthChecks> * Adding Health Checks: <https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a HTTP health check google.cloud.gcp_compute_http_health_check: name: test_object healthy_threshold: 10 port: 8080 timeout_sec: 2 unhealthy_threshold: 5 project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| checkIntervalSec integer \| success \| How often (in seconds) to send a health check. The default value is 5 seconds. \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. Provide this property when you create the resource. \| \| healthyThreshold integer \| success \| A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. \| \| host string \| success \| The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. \| \| id integer \| success \| The unique identifier for the resource. This identifier is defined by the server. \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| port* integer \| success \| The TCP port number for the HTTP health check request. The default value is 80. \| \| requestPath string \| success \| The request path of the HTTP health check request. The default value is /. \| \| timeoutSec integer \| success \| How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. \| \| unhealthyThreshold integer \| success \| A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_backend_bucket – Creates a GCP BackendBucket google.cloud.gcp\_compute\_backend\_bucket – Creates a GCP BackendBucket ======================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_backend_bucket`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Backend buckets allow you to use Google Cloud Storage buckets with HTTP(S) load balancing. * An HTTP(S) load balancer can direct traffic to specified URLs to a backend bucket rather than a backend service. It can send requests for static content to a Cloud Storage bucket and requests for dynamic content to a virtual machine instance. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| bucket\_name string / required \| \| Cloud Storage bucket name. \| \| cdn\_policy dictionary \| \| Cloud CDN configuration for this Backend Bucket. \| \| \| signed\_url\_cache\_max\_age\_sec integer \| \| Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. \| \| description string \| \| An optional textual description of the resource; provided by the client when the resource is created. \| \| enable\_cdn boolean \| Choices:* no * yes \| If true, enable Cloud CDN for this BackendBucket. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| project* string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/v1/backendBuckets> * Using a Cloud Storage bucket as a load balancer backend: <https://cloud.google.com/compute/docs/load-balancing/http/backend-bucket> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a bucket google.cloud.gcp_storage_bucket: name: bucket-backendbucket project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: bucket - name: create a backend bucket google.cloud.gcp_compute_backend_bucket: name: test_object bucket_name: "{{ bucket.name }}" description: A BackendBucket to connect LNB w/ Storage Bucket enable_cdn: 'true' project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| bucketName string \| success \| Cloud Storage bucket name. \| \| cdnPolicy complex \| success \| Cloud CDN configuration for this Backend Bucket. \| \| \| signedUrlCacheMaxAgeSec integer \| success \| Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional textual description of the resource; provided by the client when the resource is created. \| \| enableCdn boolean \| success \| If true, enable Cloud CDN for this BackendBucket. \| \| id integer \| success \| Unique identifier for the resource. \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| ### Authors Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_instance_group_manager – Creates a GCP InstanceGroupManager google.cloud.gcp\_compute\_instance\_group\_manager – Creates a GCP InstanceGroupManager ======================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_instance_group_manager`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances. * A managed instance group can have up to 1000 VM instances per group. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| base\_instance\_name string / required \| \| The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. \| \| description string \| \| An optional description of this resource. Provide this property when you create the resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| instance\_template dictionary / required \| \| The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. This field represents a link to a InstanceTemplate resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_instance\_template task and then set this instance\_template field to "{{ name-of-resource }}" \| \| name string / required \| \| The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. \| \| named\_ports list / elements=dictionary \| \| Named ports configured for the Instance Groups complementary to this Instance Group Manager. \| \| \| name string \| \| The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. \| \| \| port integer \| \| The port number, which can be a value between 1 and 65535. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| target\_pools list / elements=dictionary \| \| TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. \| \| target\_size integer \| \| The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. \| \| zone string / required \| \| The zone the managed instance group resides. \| Examples -------- ``` - name: create a network google.cloud.gcp_compute_network: name: network-instancetemplate project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: network - name: create a address google.cloud.gcp_compute_address: name: address-instancetemplate region: us-west1 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: address - name: create a instance template google.cloud.gcp_compute_instance_template: name: "{{ resource_name }}" properties: disks: - auto_delete: 'true' boot: 'true' initialize_params: source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts machine_type: n1-standard-1 network_interfaces: - network: "{{ network }}" access_configs: - name: test-config type: ONE_TO_ONE_NAT nat_ip: "{{ address }}" project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: instancetemplate - name: create a instance group manager google.cloud.gcp_compute_instance_group_manager: name: test_object base_instance_name: test1-child instance_template: "{{ instancetemplate }}" target_size: 3 zone: us-west1-a project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| baseInstanceName string \| success \| The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. \| \| creationTimestamp string \| success \| The creation timestamp for this managed instance group in RFC3339 text format. \| \| currentActions complex \| success \| The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. \| \| \| abandoning integer \| success \| The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. \| \| \| creating integer \| success \| The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. \| \| \| creatingWithoutRetries integer \| success \| The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. \| \| \| deleting integer \| success \| The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. \| \| \| none integer \| success \| The number of instances in the managed instance group that are running and have no scheduled actions. \| \| \| recreating integer \| success \| The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. \| \| \| refreshing integer \| success \| The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. \| \| \| restarting integer \| success \| The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. \| \| description string \| success \| An optional description of this resource. Provide this property when you create the resource. \| \| id integer \| success \| A unique identifier for this resource. \| \| instanceGroup dictionary \| success \| The instance group being managed. \| \| instanceTemplate dictionary \| success \| The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. \| \| name string \| success \| The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. \| \| namedPorts complex \| success \| Named ports configured for the Instance Groups complementary to this Instance Group Manager. \| \| \| name string \| success \| The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. \| \| \| port integer \| success \| The port number, which can be a value between 1 and 65535. \| \| region string \| success \| The region this managed instance group resides (for regional resources). \| \| targetPools list / elements=string \| success \| TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. \| \| targetSize integer \| success \| The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. \| \| zone string \| success \| The zone the managed instance group resides. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_compute_region_target_https_proxy – Creates a GCP RegionTargetHttpsProxy google.cloud.gcp\_compute\_region\_target\_https\_proxy – Creates a GCP RegionTargetHttpsProxy ============================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_region_target_https_proxy`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Represents a RegionTargetHttpsProxy resource, which is used by one or more forwarding rules to route incoming HTTPS requests to a URL map. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| description string \| \| An optional description of this resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| project* string \| \| The Google Cloud Platform project to use. \| \| region string / required \| \| The region where the regional proxy resides. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| ssl\_certificates list / elements=dictionary / required \| \| A list of RegionSslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| url\_map dictionary / required \| \| A reference to the RegionUrlMap resource that defines the mapping from URL to the RegionBackendService. This field represents a link to a RegionUrlMap resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_region\_url\_map task and then set this url\_map field to "{{ name-of-resource }}" \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/rest/v1/regionTargetHttpsProxies> * Official Documentation: <https://cloud.google.com/compute/docs/load-balancing/http/target-proxies> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a instance group google.cloud.gcp_compute_instance_group: name: instancegroup-targethttpsproxy zone: us-central1-a project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: instancegroup - name: create a region health check google.cloud.gcp_compute_region_health_check: name: "{{ resource_name }}" type: HTTPS healthy_threshold: 10 timeout_sec: 2 unhealthy_threshold: 5 region: us-central1 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: healthcheck - name: create a region backend service google.cloud.gcp_compute_region_backend_service: name: backendservice-targethttpsproxy region: us-central1 backends: - group: "{{ instancegroup.selfLink }}" healthchecks: - "{{ healthcheck.selfLink }}" project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: backendservice - name: create a region URL map google.cloud.gcp_compute_region_url_map: name: urlmap-targethttpsproxy region: us-central1 default_service: "{{ backendservice }}" project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: urlmap - name: create a SSL certificate google.cloud.gcp_compute_ssl_certificate: name: sslcert-targethttpsproxy description: A certificate for testing. Do not use this certificate in production certificate: \|- -----BEGIN CERTIFICATE----- MIICqjCCAk+gAwIBAgIJAIuJ+0352Kq4MAoGCCqGSM49BAMCMIGwMQswCQYDVQQG EwJVUzETMBEGA1UECAwKV2FzaGluZ3RvbjERMA8GA1UEBwwIS2lya2xhbmQxFTAT BgNVBAoMDEdvb2dsZSwgSW5jLjEeMBwGA1UECwwVR29vZ2xlIENsb3VkIFBsYXRm b3JtMR8wHQYDVQQDDBZ3d3cubXktc2VjdXJlLXNpdGUuY29tMSEwHwYJKoZIhvcN AQkBFhJuZWxzb25hQGdvb2dsZS5jb20wHhcNMTcwNjI4MDQ1NjI2WhcNMjcwNjI2 MDQ1NjI2WjCBsDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xETAP BgNVBAcMCEtpcmtsYW5kMRUwEwYDVQQKDAxHb29nbGUsIEluYy4xHjAcBgNVBAsM FUdvb2dsZSBDbG91ZCBQbGF0Zm9ybTEfMB0GA1UEAwwWd3d3Lm15LXNlY3VyZS1z aXRlLmNvbTEhMB8GCSqGSIb3DQEJARYSbmVsc29uYUBnb29nbGUuY29tMFkwEwYH KoZIzj0CAQYIKoZIzj0DAQcDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ 4mzkzTv0dXyB750fOGN02HtkpBOZzzvUARTR10JQoSe2/5PIwaNQME4wHQYDVR0O BBYEFKIQC3A2SDpxcdfn0YLKineDNq/BMB8GA1UdIwQYMBaAFKIQC3A2SDpxcdfn 0YLKineDNq/BMAwGA1UdEwQFMAMBAf8wCgYIKoZIzj0EAwIDSQAwRgIhALs4vy+O M3jcqgA4fSW/oKw6UJxp+M6a+nGMX+UJR3YgAiEAvvl39QRVAiv84hdoCuyON0lJ zqGNhIPGq2ULqXKK8BY= -----END CERTIFICATE----- private_key: \|- -----BEGIN EC PRIVATE KEY----- MHcCAQEEIObtRo8tkUqoMjeHhsOh2ouPpXCgBcP+EDxZCB/tws15oAoGCCqGSM49 AwEHoUQDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ4mzkzTv0dXyB750f OGN02HtkpBOZzzvUARTR10JQoSe2/5PIwQ== -----END EC PRIVATE KEY----- project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: sslcert - name: create a region target HTTPS proxy google.cloud.gcp_compute_region_target_https_proxy: name: test_object region: us-central1 ssl_certificates: - "{{ sslcert }}" url_map: "{{ urlmap }}" project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. \| \| id integer \| success \| The unique identifier for the resource. \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| region* string \| success \| The region where the regional proxy resides. \| \| sslCertificates list / elements=string \| success \| A list of RegionSslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified. \| \| urlMap dictionary \| success \| A reference to the RegionUrlMap resource that defines the mapping from URL to the RegionBackendService. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_region_disk_info – Gather info for GCP RegionDisk google.cloud.gcp\_compute\_region\_disk\_info – Gather info for GCP RegionDisk ============================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_region_disk_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP RegionDisk Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| region string / required \| \| A reference to the region where the disk resides. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a region disk gcp_compute_region_disk_info: region: us-central1 filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| \| description string \| success \| An optional description of this resource. Provide this property when you create the resource. \| \| \| diskEncryptionKey complex \| success \| Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot or an image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. \| \| \| \| rawKey string \| success \| Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. \| \| \| \| sha256 string \| success \| The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. \| \| \| id integer \| success \| The unique identifier for the resource. \| \| \| labelFingerprint string \| success \| The fingerprint used for optimistic locking of this resource. Used internally during updates. \| \| \| labels dictionary \| success \| Labels to apply to this disk. A list of key->value pairs. \| \| \| lastAttachTimestamp string \| success \| Last attach timestamp in RFC3339 text format. \| \| \| lastDetachTimestamp string \| success \| Last detach timestamp in RFC3339 text format. \| \| \| licenses list / elements=string \| success \| Any applicable publicly visible licenses. \| \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| physicalBlockSizeBytes* integer \| success \| Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. \| \| \| region string \| success \| A reference to the region where the disk resides. \| \| \| replicaZones list / elements=string \| success \| URLs of the zones where the disk should be replicated to. \| \| \| sizeGb integer \| success \| Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. \| \| \| sourceSnapshot dictionary \| success \| The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. \| \| \| sourceSnapshotEncryptionKey complex \| success \| The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. \| \| \| \| rawKey string \| success \| Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. \| \| \| \| sha256 string \| success \| The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. \| \| \| sourceSnapshotId string \| success \| The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. \| \| \| type string \| success \| URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. \| \| \| users list / elements=string \| success \| Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance . \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_forwarding_rule – Creates a GCP ForwardingRule google.cloud.gcp\_compute\_forwarding\_rule – Creates a GCP ForwardingRule ========================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_forwarding_rule`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| all\_ports boolean \| Choices:* no * yes \| For internal TCP/UDP load balancing (i.e. load balancing scheme is INTERNAL and protocol is TCP/UDP), set this to true to allow packets addressed to any ports to be forwarded to the backends configured with this forwarding rule. Used with backend service. Cannot be set if port or portRange are set. \| \| allow\_global\_access boolean \| Choices:* no * yes \| If true, clients can access ILB from all regions. Otherwise only allows from the local region the ILB is located at. \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| backend\_service dictionary \| \| A BackendService to receive the matched traffic. This is used only for INTERNAL load balancing. This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_backend\_service task and then set this backend\_service field to "{{ name-of-resource }}" \| \| description string \| \| An optional description of this resource. Provide this property when you create the resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| ip\_address string \| \| The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: \* 100.1.2.3 \* <https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address> \* projects/project/regions/region/addresses/address \* regions/region/addresses/address \* global/addresses/address \* address . \| \| ip\_protocol string \| \| The IP protocol to which this rule applies. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. Some valid choices include: "TCP", "UDP", "ESP", "AH", "SCTP", "ICMP" \| \| is\_mirroring\_collector boolean \| Choices:* no * yes \| Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. \| \| load\_balancing\_scheme string \| \| This signifies what the ForwardingRule will be used for and can be EXTERNAL, INTERNAL, or INTERNAL\_MANAGED. EXTERNAL is used for Classic Cloud VPN gateways, protocol forwarding to VMs from an external IP address, and HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP load balancers. INTERNAL is used for protocol forwarding to VMs from an internal IP address, and internal TCP/UDP load balancers. INTERNAL\_MANAGED is used for internal HTTP(S) load balancers. Some valid choices include: "EXTERNAL", "INTERNAL", "INTERNAL\_MANAGED" \| \| name string / required \| \| Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| network* dictionary \| \| For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. This field is only used for INTERNAL load balancing. This field represents a link to a Network resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_network task and then set this network field to "{{ name-of-resource }}" \| \| network\_tier string \| \| The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM. Some valid choices include: "PREMIUM", "STANDARD" \| \| port\_range string \| \| This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: \* TargetHttpProxy: 80, 8080 \* TargetHttpsProxy: 443 \* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 \* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 \* TargetVpnGateway: 500, 4500 . \| \| ports list / elements=string \| \| This field is used along with the backend\_service field for internal load balancing. When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports. \| \| project string \| \| The Google Cloud Platform project to use. \| \| region string / required \| \| A reference to the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| service\_label string \| \| An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for INTERNAL load balancing. \| \| state* string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| subnetwork dictionary \| \| The subnetwork that the load balanced IP should belong to for this Forwarding Rule. This field is only used for INTERNAL load balancing. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. This field represents a link to a Subnetwork resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_subnetwork task and then set this subnetwork field to "{{ name-of-resource }}" \| \| target string \| \| The URL of the target resource to receive the matched traffic. The target must live in the same region as the forwarding rule. The forwarded traffic must be of a type appropriate to the target object. \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/v1/forwardingRules> * Official Documentation: <https://cloud.google.com/compute/docs/load-balancing/network/forwarding-rules> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a address google.cloud.gcp_compute_address: name: address-forwardingrule region: us-west1 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: address - name: create a target pool google.cloud.gcp_compute_target_pool: name: targetpool-forwardingrule region: us-west1 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: targetpool - name: create a forwarding rule google.cloud.gcp_compute_forwarding_rule: name: test_object region: us-west1 target: "{{ targetpool }}" ip_protocol: TCP port_range: 80-80 ip_address: "{{ address.address }}" project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| allowGlobalAccess boolean \| success \| If true, clients can access ILB from all regions. Otherwise only allows from the local region the ILB is located at. \| \| allPorts boolean \| success \| For internal TCP/UDP load balancing (i.e. load balancing scheme is INTERNAL and protocol is TCP/UDP), set this to true to allow packets addressed to any ports to be forwarded to the backends configured with this forwarding rule. Used with backend service. Cannot be set if port or portRange are set. \| \| backendService dictionary \| success \| A BackendService to receive the matched traffic. This is used only for INTERNAL load balancing. \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. Provide this property when you create the resource. \| \| id integer \| success \| The unique identifier for the resource. \| \| IPAddress string \| success \| The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: \* 100.1.2.3 \* <https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address> \* projects/project/regions/region/addresses/address \* regions/region/addresses/address \* global/addresses/address \* address . \| \| IPProtocol string \| success \| The IP protocol to which this rule applies. When the load balancing scheme is INTERNAL, only TCP and UDP are valid. \| \| isMirroringCollector boolean \| success \| Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. \| \| loadBalancingScheme string \| success \| This signifies what the ForwardingRule will be used for and can be EXTERNAL, INTERNAL, or INTERNAL\_MANAGED. EXTERNAL is used for Classic Cloud VPN gateways, protocol forwarding to VMs from an external IP address, and HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP load balancers. INTERNAL is used for protocol forwarding to VMs from an internal IP address, and internal TCP/UDP load balancers. INTERNAL\_MANAGED is used for internal HTTP(S) load balancers. \| \| name string \| success \| Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| network* dictionary \| success \| For internal load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used. This field is only used for INTERNAL load balancing. \| \| networkTier string \| success \| The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM. \| \| portRange string \| success \| This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: \* TargetHttpProxy: 80, 8080 \* TargetHttpsProxy: 443 \* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 \* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 \* TargetVpnGateway: 500, 4500 . \| \| ports list / elements=string \| success \| This field is used along with the backend\_service field for internal load balancing. When the load balancing scheme is INTERNAL, a single port or a comma separated list of ports can be configured. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. You may specify a maximum of up to 5 ports. \| \| region string \| success \| A reference to the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. \| \| serviceLabel string \| success \| An optional prefix to the service name for this Forwarding Rule. If specified, will be the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for INTERNAL load balancing. \| \| serviceName* string \| success \| The internal fully qualified service name for this Forwarding Rule. This field is only used for INTERNAL load balancing. \| \| subnetwork dictionary \| success \| The subnetwork that the load balanced IP should belong to for this Forwarding Rule. This field is only used for INTERNAL load balancing. If the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified. \| \| target string \| success \| The URL of the target resource to receive the matched traffic. The target must live in the same region as the forwarding rule. The forwarded traffic must be of a type appropriate to the target object. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_bigquery_dataset_info – Gather info for GCP Dataset google.cloud.gcp\_bigquery\_dataset\_info – Gather info for GCP Dataset ======================================================================= Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_bigquery_dataset_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP Dataset Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a dataset gcp_bigquery_dataset_info: project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| access complex \| success \| An array of objects that define dataset access for one or more entities. \| \| \| \| domain string \| success \| A domain to grant access to. Any users signed in with the domain specified will be granted the specified access . \| \| \| \| groupByEmail string \| success \| An email address of a Google Group to grant access to. \| \| \| \| role string \| success \| Describes the rights granted to the user specified by the other member of the access object. Basic, predefined, and custom roles are supported. Predefined roles that have equivalent basic roles are swapped by the API to their basic counterparts. See [official docs](<https://cloud.google.com/bigquery/docs/access-control>). \| \| \| \| specialGroup string \| success \| A special group to grant access to. Possible values include: \* `projectOwners`: Owners of the enclosing project. \* `projectReaders`: Readers of the enclosing project. \* `projectWriters`: Writers of the enclosing project. \* `allAuthenticatedUsers`: All authenticated BigQuery users. \| \| \| \| userByEmail string \| success \| An email address of a user to grant access to. For example: [email protected] . \| \| \| \| view complex \| success \| A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. \| \| \| \| \| datasetId string \| success \| The ID of the dataset containing this table. \| \| \| \| \| projectId string \| success \| The ID of the project containing this table. \| \| \| \| \| tableId string \| success \| The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores. The maximum length is 1,024 characters. \| \| \| creationTime integer \| success \| The time when this dataset was created, in milliseconds since the epoch. \| \| \| datasetReference complex \| success \| A reference that identifies the dataset. \| \| \| \| datasetId string \| success \| A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores. The maximum length is 1,024 characters. \| \| \| \| projectId string \| success \| The ID of the project containing this dataset. \| \| \| defaultEncryptionConfiguration complex \| success \| The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. \| \| \| \| kmsKeyName string \| success \| Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. \| \| \| defaultPartitionExpirationMs integer \| success \| The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an `expirationMs` property in the `timePartitioning` settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of `defaultTableExpirationMs` for partitioned tables: only one of `defaultTableExpirationMs` and `defaultPartitionExpirationMs` will be used for any new partitioned table. If you provide an explicit `timePartitioning.expirationMs` when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property. \| \| \| defaultTableExpirationMs integer \| success \| The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an `expirationTime` property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the `expirationTime` for a given table is reached, that table will be deleted automatically. If a table's `expirationTime` is modified or removed before the table expires, or if you provide an explicit `expirationTime` when creating a table, that value takes precedence over the default expiration time indicated by this property. \| \| \| description string \| success \| A user-friendly description of the dataset. \| \| \| etag string \| success \| A hash of the resource. \| \| \| friendlyName string \| success \| A descriptive name for the dataset. \| \| \| id string \| success \| The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field . \| \| \| labels dictionary \| success \| The labels associated with this dataset. You can use these to organize and group your datasets . \| \| \| lastModifiedTime integer \| success \| The date when this dataset or any of its tables was last modified, in milliseconds since the epoch. \| \| \| location string \| success \| The geographic location where the dataset should reside. See [official docs](<https://cloud.google.com/bigquery/docs/dataset-locations>). There are two types of locations, regional or multi-regional. A regional location is a specific geographic place, such as Tokyo, and a multi-regional location is a large geographic area, such as the United States, that contains at least two geographic places. The default value is multi-regional location `US`. Changing this forces a new resource to be created. \| \| \| name string \| success \| Dataset name. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_sql_user – Creates a GCP User google.cloud.gcp\_sql\_user – Creates a GCP User ================================================ Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_sql_user`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * The Users resource represents a database user in a Cloud SQL instance. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| host string / required \| \| The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. \| \| instance dictionary / required \| \| The name of the Cloud SQL instance. This does not include the project ID. This field represents a link to a Instance resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'name' and value of your resource's name Alternatively, you can add `register: name-of-resource` to a gcp\_sql\_instance task and then set this instance field to "{{ name-of-resource }}" \| \| name string / required \| \| The name of the user in the Cloud SQL instance. \| \| password string \| \| The password for the user. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| Examples -------- ``` - name: create a instance google.cloud.gcp_sql_instance: name: "{{resource_name}}-1" settings: ip_configuration: authorized_networks: - name: google dns server value: 8.8.8.8/32 tier: db-n1-standard-1 region: us-central1 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: instance - name: create a user google.cloud.gcp_sql_user: name: test-user host: 10.1.2.3 password: secret-password instance: "{{ instance }}" project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| host string \| success \| The host name from which the user can connect. For insert operations, host defaults to an empty string. For update operations, host is specified as part of the request URL. The host name cannot be updated after insertion. \| \| instance dictionary \| success \| The name of the Cloud SQL instance. This does not include the project ID. \| \| name string \| success \| The name of the user in the Cloud SQL instance. \| \| password string \| success \| The password for the user. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_ssl_policy_info – Gather info for GCP SslPolicy google.cloud.gcp\_compute\_ssl\_policy\_info – Gather info for GCP SslPolicy ============================================================================ Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_ssl_policy_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP SslPolicy Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a SSL policy gcp_compute_ssl_policy_info: filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| \| customFeatures list / elements=string \| success \| A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. \| \| \| description string \| success \| An optional description of this resource. \| \| \| enabledFeatures list / elements=string \| success \| The list of features enabled in the SSL policy. \| \| \| fingerprint string \| success \| Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. \| \| \| id integer \| success \| The unique identifier for the resource. \| \| \| minTlsVersion string \| success \| The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. \| \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| profile* string \| success \| Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. If using `CUSTOM`, the set of SSL features to enable must be specified in the `customFeatures` field. \| \| \| warnings complex \| success \| If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. \| \| \| \| code string \| success \| A warning code, if applicable. \| \| \| \| message string \| success \| A human-readable description of the warning code. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_backend_bucket_info – Gather info for GCP BackendBucket google.cloud.gcp\_compute\_backend\_bucket\_info – Gather info for GCP BackendBucket ==================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_backend_bucket_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP BackendBucket Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a backend bucket gcp_compute_backend_bucket_info: filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| bucketName string \| success \| Cloud Storage bucket name. \| \| \| cdnPolicy complex \| success \| Cloud CDN configuration for this Backend Bucket. \| \| \| \| signedUrlCacheMaxAgeSec integer \| success \| Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a "Cache-Control: public, max-age=[TTL]" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered. \| \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| \| description string \| success \| An optional textual description of the resource; provided by the client when the resource is created. \| \| \| enableCdn boolean \| success \| If true, enable Cloud CDN for this BackendBucket. \| \| \| id integer \| success \| Unique identifier for the resource. \| \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| ### Authors Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_cloudfunctions_cloud_function – Creates a GCP CloudFunction google.cloud.gcp\_cloudfunctions\_cloud\_function – Creates a GCP CloudFunction =============================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_cloudfunctions_cloud_function`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * A Cloud Function that contains user computation executed in response to an event. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| available\_memory\_mb integer \| \| The amount of memory in MB available for a function. \| \| description string \| \| User-provided description of a function. \| \| entry\_point string \| \| The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source\_location. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| environment\_variables dictionary \| \| Environment variables that shall be available during function execution. \| \| event\_trigger dictionary \| \| An HTTPS endpoint type of source that can be triggered via URL. \| \| \| event\_type string / required \| \| The type of event to observe. For example: `providers/cloud.storage/eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish`. \| \| \| resource string / required \| \| The resource(s) from which to observe events, for example, `projects/\_/buckets/myBucket.` . \| \| \| service string \| \| The hostname of the service that should be observed. \| \| https\_trigger dictionary \| \| An HTTPS endpoint type of source that can be triggered via URL. \| \| labels dictionary \| \| A set of key/value label pairs associated with this Cloud Function. \| \| location string / required \| \| The location of this cloud function. \| \| name string / required \| \| A user-defined name of the function. Function names must be unique globally and match pattern `projects/\/locations/\/functions/\`. \| \| project* string \| \| The Google Cloud Platform project to use. \| \| runtime string \| \| The runtime in which the function is going to run. If empty, defaults to Node.js 6. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| source\_archive\_url string \| \| The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. \| \| source\_repository dictionary \| \| The source repository where a function is hosted. \| \| \| url string / required \| \| The URL pointing to the hosted repository where the function is defined . \| \| source\_upload\_url string \| \| The Google Cloud Storage signed URL used for source uploading. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| timeout string \| \| The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. \| \| trigger\_http boolean \| Choices:* no * yes \| Use HTTP to trigger this function. \| Examples -------- ``` - name: create a cloud function google.cloud.gcp_cloudfunctions_cloud_function: name: test_object location: us-central1 entry_point: helloGET source_archive_url: gs://ansible-cloudfunctions-bucket/function.zip trigger_http: 'true' project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| availableMemoryMb integer \| success \| The amount of memory in MB available for a function. \| \| description string \| success \| User-provided description of a function. \| \| entryPoint string \| success \| The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source\_location. \| \| environmentVariables dictionary \| success \| Environment variables that shall be available during function execution. \| \| eventTrigger complex \| success \| An HTTPS endpoint type of source that can be triggered via URL. \| \| \| eventType string \| success \| The type of event to observe. For example: `providers/cloud.storage/eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish`. \| \| \| resource string \| success \| The resource(s) from which to observe events, for example, `projects/\_/buckets/myBucket.` . \| \| \| service string \| success \| The hostname of the service that should be observed. \| \| httpsTrigger complex \| success \| An HTTPS endpoint type of source that can be triggered via URL. \| \| \| url string \| success \| The deployed url for the function. \| \| labels dictionary \| success \| A set of key/value label pairs associated with this Cloud Function. \| \| location string \| success \| The location of this cloud function. \| \| name string \| success \| A user-defined name of the function. Function names must be unique globally and match pattern `projects/\/locations/\/functions/\`. \| \| runtime* string \| success \| The runtime in which the function is going to run. If empty, defaults to Node.js 6. \| \| serviceAccountEmail string \| success \| The email of the service account for this function. \| \| sourceArchiveUrl string \| success \| The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. \| \| sourceRepository complex \| success \| The source repository where a function is hosted. \| \| \| deployedUrl string \| success \| The URL pointing to the hosted repository where the function were defined at the time of deployment. \| \| \| url string \| success \| The URL pointing to the hosted repository where the function is defined . \| \| sourceUploadUrl string \| success \| The Google Cloud Storage signed URL used for source uploading. \| \| status string \| success \| Status of the function deployment. \| \| timeout string \| success \| The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. \| \| trigger\_http boolean \| success \| Use HTTP to trigger this function. \| \| updateTime string \| success \| The last update timestamp of a Cloud Function. \| \| versionId string \| success \| The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_pubsub_subscription_info – Gather info for GCP Subscription google.cloud.gcp\_pubsub\_subscription\_info – Gather info for GCP Subscription =============================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_pubsub_subscription_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP Subscription Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a subscription gcp_pubsub_subscription_info: project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| ackDeadlineSeconds integer \| success \| This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. \| \| \| deadLetterPolicy complex \| success \| A policy that specifies the conditions for dead lettering messages in this subscription. If dead\_letter\_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscription's parent project (i.e., service-{project\_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. \| \| \| \| deadLetterTopic string \| success \| The name of the topic to which dead letter messages should be published. Format is `projects/{project}/topics/{topic}`. The Cloud Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project\_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. \| \| \| \| maxDeliveryAttempts integer \| success \| The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack\_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. \| \| \| enableMessageOrdering boolean \| success \| If `true`, messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. \| \| \| expirationPolicy complex \| success \| A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expirationPolicy is not set, a default policy with ttl of 31 days will be used. If it is set but ttl is "", the resource never expires. The minimum allowed value for expirationPolicy.ttl is 1 day. \| \| \| \| ttl string \| success \| Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. If ttl is not set, the associated resource never expires. A duration in seconds with up to nine fractional digits, terminated by 's'. Example - "3.5s". \| \| \| filter string \| success \| The subscription only delivers the messages that match the filter. Pub/Sub automatically acknowledges the messages that don't match the filter. You can filter messages by their attributes. The maximum length of a filter is 256 bytes. After creating the subscription, you can't modify the filter. \| \| \| labels dictionary \| success \| A set of key/value label pairs to assign to this Subscription. \| \| \| messageRetentionDuration string \| success \| How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If retainAckedMessages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a subscriptions.seek can be done. Defaults to 7 days. Cannot be more than 7 days (`"604800s"`) or less than 10 minutes (`"600s"`). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: `"600.5s"`. \| \| \| name string \| success \| Name of the subscription. \| \| \| pushConfig complex \| success \| If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods. \| \| \| \| attributes dictionary \| success \| Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the subscriptions.create call, it will default to the version of the API used to make such call. If not present during a subscriptions.modifyPushConfig call, its value will not be changed. subscriptions.get calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: - v1beta1: uses the push format defined in the v1beta1 Pub/Sub API. - v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. \| \| \| \| oidcToken complex \| success \| If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message. \| \| \| \| \| audience string \| success \| Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: <https://tools.ietf.org/html/rfc7519#section-4.1.3> Note: if not specified, the Push endpoint URL will be used. \| \| \| \| \| serviceAccountEmail string \| success \| Service account email to be used for generating the OIDC token. The caller (for subscriptions.create, subscriptions.patch, and subscriptions.modifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account. \| \| \| \| pushEndpoint string \| success \| A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "[https://example.com/push"](#). \| \| \| retainAckedMessages boolean \| success \| Indicates whether to retain acknowledged messages. If `true`, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the messageRetentionDuration window. \| \| \| retryPolicy complex \| success \| A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message . \| \| \| \| maximumBackoff string \| success \| The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". \| \| \| \| minimumBackoff string \| success \| The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". \| \| \| topic dictionary \| success \| A reference to a Topic resource. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_cloudfunctions_cloud_function_info – Gather info for GCP CloudFunction google.cloud.gcp\_cloudfunctions\_cloud\_function\_info – Gather info for GCP CloudFunction =========================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_cloudfunctions_cloud_function_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP CloudFunction Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| location string / required \| \| The location of this cloud function. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a cloud function gcp_cloudfunctions_cloud_function_info: location: us-central1 project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| availableMemoryMb integer \| success \| The amount of memory in MB available for a function. \| \| \| description string \| success \| User-provided description of a function. \| \| \| entryPoint string \| success \| The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source\_location. \| \| \| environmentVariables dictionary \| success \| Environment variables that shall be available during function execution. \| \| \| eventTrigger complex \| success \| An HTTPS endpoint type of source that can be triggered via URL. \| \| \| \| eventType string \| success \| The type of event to observe. For example: `providers/cloud.storage/eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish`. \| \| \| \| resource string \| success \| The resource(s) from which to observe events, for example, `projects/\_/buckets/myBucket.` . \| \| \| \| service string \| success \| The hostname of the service that should be observed. \| \| \| httpsTrigger complex \| success \| An HTTPS endpoint type of source that can be triggered via URL. \| \| \| \| url string \| success \| The deployed url for the function. \| \| \| labels dictionary \| success \| A set of key/value label pairs associated with this Cloud Function. \| \| \| location string \| success \| The location of this cloud function. \| \| \| name string \| success \| A user-defined name of the function. Function names must be unique globally and match pattern `projects/\/locations/\/functions/\`. \| \| \| runtime* string \| success \| The runtime in which the function is going to run. If empty, defaults to Node.js 6. \| \| \| serviceAccountEmail string \| success \| The email of the service account for this function. \| \| \| sourceArchiveUrl string \| success \| The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. \| \| \| sourceRepository complex \| success \| The source repository where a function is hosted. \| \| \| \| deployedUrl string \| success \| The URL pointing to the hosted repository where the function were defined at the time of deployment. \| \| \| \| url string \| success \| The URL pointing to the hosted repository where the function is defined . \| \| \| sourceUploadUrl string \| success \| The Google Cloud Storage signed URL used for source uploading. \| \| \| status string \| success \| Status of the function deployment. \| \| \| timeout string \| success \| The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. \| \| \| trigger\_http boolean \| success \| Use HTTP to trigger this function. \| \| \| updateTime string \| success \| The last update timestamp of a Cloud Function. \| \| \| versionId string \| success \| The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_global_forwarding_rule_info – Gather info for GCP GlobalForwardingRule google.cloud.gcp\_compute\_global\_forwarding\_rule\_info – Gather info for GCP GlobalForwardingRule ==================================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_global_forwarding_rule_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP GlobalForwardingRule Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a global forwarding rule gcp_compute_global_forwarding_rule_info: filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| \| description string \| success \| An optional description of this resource. Provide this property when you create the resource. \| \| \| id integer \| success \| The unique identifier for the resource. \| \| \| IPAddress string \| success \| The IP address that this forwarding rule is serving on behalf of. Addresses are restricted based on the forwarding rule's load balancing scheme (EXTERNAL or INTERNAL) and scope (global or regional). When the load balancing scheme is EXTERNAL, for global forwarding rules, the address must be a global IP, and for regional forwarding rules, the address must live in the same region as the forwarding rule. If this field is empty, an ephemeral IPv4 address from the same scope (global or regional) will be assigned. A regional forwarding rule supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP address belonging to the network/subnet configured for the forwarding rule. By default, if this field is empty, an ephemeral internal IP address will be automatically allocated from the IP range of the subnet or network configured for this forwarding rule. An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: \* 100.1.2.3 \* <https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address> \* projects/project/regions/region/addresses/address \* regions/region/addresses/address \* global/addresses/address \* address . \| \| \| IPProtocol string \| success \| The IP protocol to which this rule applies. When the load balancing scheme is INTERNAL\_SELF\_MANAGED, only TCP is valid. \| \| \| ipVersion string \| success \| The IP Version that will be used by this global forwarding rule. \| \| \| loadBalancingScheme string \| success \| This signifies what the GlobalForwardingRule will be used for. The value of INTERNAL\_SELF\_MANAGED means that this will be used for Internal Global HTTP(S) LB. The value of EXTERNAL means that this will be used for External Global Load Balancing (HTTP(S) LB, External TCP/UDP LB, SSL Proxy) NOTE: Currently global forwarding rules cannot be used for INTERNAL load balancing. \| \| \| metadataFilters complex \| success \| Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH\_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH\_ALL, then all of its filterLabels must match with corresponding labels in the provided metadata. metadataFilters specified here can be overridden by those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL\_SELF\_MANAGED. \| \| \| \| filterLabels complex \| success \| The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. \| \| \| \| \| name string \| success \| Name of the metadata label. The length must be between 1 and 1024 characters, inclusive. \| \| \| \| \| value string \| success \| The value that the label must match. The value has a maximum length of 1024 characters. \| \| \| \| filterMatchCriteria string \| success \| Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. MATCH\_ANY - At least one of the filterLabels must have a matching label in the provided metadata. MATCH\_ALL - All filterLabels must have matching labels in the provided metadata. \| \| \| name string \| success \| Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| network* dictionary \| success \| This field is not used for external load balancing. For INTERNAL\_SELF\_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this global forwarding rule. If this field is not specified, the default network will be used. \| \| \| portRange string \| success \| This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance. Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges. Some types of forwarding target have constraints on the acceptable ports: \* TargetHttpProxy: 80, 8080 \* TargetHttpsProxy: 443 \* TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 \* TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1883, 5222 \* TargetVpnGateway: 500, 4500 . \| \| \| target string \| success \| The URL of the target resource to receive the matched traffic. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL\_SELF\_MANAGED load balancing, only HTTP and HTTPS targets are valid. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_external_vpn_gateway_info – Gather info for GCP ExternalVpnGateway google.cloud.gcp\_compute\_external\_vpn\_gateway\_info – Gather info for GCP ExternalVpnGateway ================================================================================================ Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_external_vpn_gateway_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP ExternalVpnGateway Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on an external vpn gateway gcp_compute_external_vpn_gateway_info: filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| description string \| success \| An optional description of this resource. \| \| \| interfaces complex \| success \| A list of interfaces on this external VPN gateway. \| \| \| \| id integer \| success \| The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway \* `0 - SINGLE\_IP\_INTERNALLY\_REDUNDANT` \* `0, 1 - TWO\_IPS\_REDUNDANCY` \* `0, 1, 2, 3 - FOUR\_IPS\_REDUNDANCY` . \| \| \| \| ipAddress string \| success \| IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. \| \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| redundancyType* string \| success \| Indicates the redundancy type of this external VPN gateway . \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_compute_region_autoscaler – Creates a GCP RegionAutoscaler google.cloud.gcp\_compute\_region\_autoscaler – Creates a GCP RegionAutoscaler ============================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_region_autoscaler`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Represents an Autoscaler resource. * Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| autoscaling\_policy dictionary / required \| \| The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. \| \| \| cool\_down\_period\_sec integer \| Default:"60" \| The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. \| \| \| cpu\_utilization dictionary \| \| Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. \| \| \| \| utilization\_target string \| \| The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. \| \| \| custom\_metric\_utilizations list / elements=dictionary \| \| Configuration parameters of autoscaling based on a custom metric. \| \| \| \| metric string / required \| \| The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. \| \| \| \| utilization\_target string \| \| The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilizationTarget is <www.googleapis.com/compute/instance/network/received_bytes_count>. The autoscaler will work to keep this value constant for each of the instances. \| \| \| \| utilization\_target\_type string \| \| Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Some valid choices include: "GAUGE", "DELTA\_PER\_SECOND", "DELTA\_PER\_MINUTE" \| \| \| load\_balancing\_utilization dictionary \| \| Configuration parameters of autoscaling based on a load balancer. \| \| \| \| utilization\_target string \| \| Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. \| \| \| max\_num\_replicas integer / required \| \| The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. \| \| \| min\_num\_replicas integer \| \| The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. \| \| \| mode string \| Default:"ON" \| Defines operating mode for this policy. Some valid choices include: "OFF", "ONLY\_UP", "ON" \| \| \| scale\_in\_control dictionary \| \| Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events . \| \| \| \| max\_scaled\_in\_replicas dictionary \| \| A nested object resource. \| \| \| \| \| fixed integer \| \| Specifies a fixed number of VM instances. This must be a positive integer. \| \| \| \| \| percent integer \| \| Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. \| \| \| \| time\_window\_sec integer \| \| How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above. \| \| description string \| \| An optional description of this resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| name string / required \| \| Name of the resource. The name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| project* string \| \| The Google Cloud Platform project to use. \| \| region string / required \| \| URL of the region where the instance group resides. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| target string / required \| \| URL of the managed instance group that this autoscaler will scale. \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/rest/v1/regionAutoscalers> * Autoscaling Groups of Instances: <https://cloud.google.com/compute/docs/autoscaler/> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a network google.cloud.gcp_compute_network: name: network-instancetemplate project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: network - name: create a address google.cloud.gcp_compute_address: name: address-instancetemplate region: us-central1 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: address - name: create a instance template google.cloud.gcp_compute_instance_template: name: "{{ resource_name }}" properties: disks: - auto_delete: 'true' boot: 'true' initialize_params: source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts machine_type: n1-standard-1 network_interfaces: - network: "{{ network }}" access_configs: - name: test-config type: ONE_TO_ONE_NAT nat_ip: "{{ address }}" project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: instancetemplate - name: create a region instance group manager google.cloud.gcp_compute_region_instance_group_manager: name: "{{ resource_name }}" base_instance_name: test1-child region: us-central1 instance_template: "{{ instancetemplate }}" target_size: 3 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: igrm - name: create a region autoscaler google.cloud.gcp_compute_region_autoscaler: name: my-region-autoscaler region: us-central1 autoscaling_policy: min_num_replicas: 1 max_num_replicas: 5 cool_down_period_sec: 60 cpu_utilization: utilization_target: 0.5 target: "{{igrm.selfLink}}" project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| autoscalingPolicy complex \| success \| The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. \| \| \| coolDownPeriodSec integer \| success \| The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process. \| \| \| cpuUtilization complex \| success \| Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. \| \| \| \| utilizationTarget string \| success \| The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. \| \| \| customMetricUtilizations complex \| success \| Configuration parameters of autoscaling based on a custom metric. \| \| \| \| metric string \| success \| The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE. \| \| \| \| utilizationTarget string \| success \| The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilizationTarget is <www.googleapis.com/compute/instance/network/received_bytes_count>. The autoscaler will work to keep this value constant for each of the instances. \| \| \| \| utilizationTargetType string \| success \| Defines how target utilization value is expressed for a Stackdriver Monitoring metric. \| \| \| loadBalancingUtilization complex \| success \| Configuration parameters of autoscaling based on a load balancer. \| \| \| \| utilizationTarget string \| success \| Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8. \| \| \| maxNumReplicas integer \| success \| The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas. \| \| \| minNumReplicas integer \| success \| The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed. \| \| \| mode string \| success \| Defines operating mode for this policy. \| \| \| scaleInControl complex \| success \| Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events . \| \| \| \| maxScaledInReplicas complex \| success \| A nested object resource. \| \| \| \| \| fixed integer \| success \| Specifies a fixed number of VM instances. This must be a positive integer. \| \| \| \| \| percent integer \| success \| Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%. \| \| \| \| timeWindowSec integer \| success \| How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above. \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. \| \| id integer \| success \| Unique identifier for the resource. \| \| name string \| success \| Name of the resource. The name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| region* string \| success \| URL of the region where the instance group resides. \| \| target string \| success \| URL of the managed instance group that this autoscaler will scale. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_address_info – Gather info for GCP Address google.cloud.gcp\_compute\_address\_info – Gather info for GCP Address ====================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_address_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP Address Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| region string / required \| \| URL of the region where the regional address resides. This field is not applicable to global addresses. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on an address gcp_compute_address_info: region: us-west1 filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| address string \| success \| The static external IP address represented by this resource. Only IPv4 is supported. An address may only be specified for INTERNAL address types. The IP address must be inside the specified subnetwork, if any. \| \| \| addressType string \| success \| The type of address to reserve. \| \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| \| description string \| success \| An optional description of this resource. \| \| \| id integer \| success \| The unique identifier for the resource. \| \| \| name string \| success \| Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| networkTier* string \| success \| The networking tier used for configuring this address. If this field is not specified, it is assumed to be PREMIUM. \| \| \| purpose string \| success \| The purpose of this resource, which can be one of the following values: \* GCE\_ENDPOINT for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. \* SHARED\_LOADBALANCER\_VIP for an address that can be used by multiple internal load balancers. \* VPC\_PEERING for addresses that are reserved for VPC peer networks. This should only be set when using an Internal address. \| \| \| region string \| success \| URL of the region where the regional address resides. This field is not applicable to global addresses. \| \| \| status string \| success \| The status of the address, which can be one of RESERVING, RESERVED, or IN\_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN\_USE address is currently being used by another resource and is not available. \| \| \| subnetwork dictionary \| success \| The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE\_ENDPOINT/DNS\_RESOLVER purposes. \| \| \| users list / elements=string \| success \| The URLs of the resources that are using this address. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_mlengine_model_info – Gather info for GCP Model google.cloud.gcp\_mlengine\_model\_info – Gather info for GCP Model =================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_mlengine_model_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP Model Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a model gcp_mlengine_model_info: project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| defaultVersion complex \| success \| The default version of the model. This version will be used to handle prediction requests that do not specify a version. \| \| \| \| name string \| success \| The name specified for the version when it was created. \| \| \| description string \| success \| The description specified for the model when it was created. \| \| \| labels dictionary \| success \| One or more labels that you can add, to organize your models. \| \| \| name string \| success \| The name specified for the model. \| \| \| onlinePredictionConsoleLogging boolean \| success \| If true, online prediction nodes send stderr and stdout streams to Stackdriver Logging. \| \| \| onlinePredictionLogging boolean \| success \| If true, online prediction access logs are sent to StackDriver Logging. \| \| \| regions list / elements=string \| success \| The list of regions where the model is going to be deployed. Currently only one region per model is supported . \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_firewall_info – Gather info for GCP Firewall google.cloud.gcp\_compute\_firewall\_info – Gather info for GCP Firewall ======================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_firewall_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP Firewall Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a firewall gcp_compute_firewall_info: filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| allowed complex \| success \| The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. \| \| \| \| ip\_protocol string \| success \| The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp, ipip, all), or the IP protocol number. \| \| \| \| ports list / elements=string \| success \| An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. \| \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| \| denied complex \| success \| The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. \| \| \| \| ip\_protocol string \| success \| The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp, ipip, all), or the IP protocol number. \| \| \| \| ports list / elements=string \| success \| An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. \| \| \| description string \| success \| An optional description of this resource. Provide this property when you create the resource. \| \| \| destinationRanges list / elements=string \| success \| If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. \| \| \| direction string \| success \| Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags. \| \| \| disabled boolean \| success \| Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. \| \| \| id integer \| success \| The unique identifier for the resource. \| \| \| logConfig complex \| success \| This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging. \| \| \| \| enable boolean \| success \| This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. \| \| \| \| metadata string \| success \| This field denotes whether to include or exclude metadata for firewall logs. \| \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| network* dictionary \| success \| URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: <https://www.googleapis.com/compute/v1/projects/myproject/global/> networks/my-network projects/myproject/global/networks/my-network global/networks/default . \| \| \| priority integer \| success \| Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. \| \| \| sourceRanges list / elements=string \| success \| If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. \| \| \| sourceServiceAccounts list / elements=string \| success \| If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. \| \| \| sourceTags list / elements=string \| success \| If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. \| \| \| targetServiceAccounts list / elements=string \| success \| A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. \| \| \| targetTags list / elements=string \| success \| A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_region_instance_group_manager – Creates a GCP RegionInstanceGroupManager google.cloud.gcp\_compute\_region\_instance\_group\_manager – Creates a GCP RegionInstanceGroupManager ====================================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_region_instance_group_manager`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances. * A managed instance group can have up to 1000 VM instances per group. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| auto\_healing\_policies list / elements=dictionary \| \| The autohealing policy for this managed instance group . \| \| \| health\_check string \| \| The URL for the health check that signals autohealing. \| \| \| initial\_delay\_sec integer \| \| The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances . \| \| base\_instance\_name string / required \| \| The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. \| \| description string \| \| An optional description of this resource. Provide this property when you create the resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| instance\_template dictionary / required \| \| The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. This field represents a link to a InstanceTemplate resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_instance\_template task and then set this instance\_template field to "{{ name-of-resource }}" \| \| name string / required \| \| The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. \| \| named\_ports list / elements=dictionary \| \| Named ports configured for the Instance Groups complementary to this Instance Group Manager. \| \| \| name string \| \| The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. \| \| \| port integer \| \| The port number, which can be a value between 1 and 65535. \| \| project string \| \| The Google Cloud Platform project to use. \| \| region string / required \| \| The region the managed instance group resides. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| target\_pools list / elements=dictionary \| \| TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. \| \| target\_size integer \| \| The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. \| Examples -------- ``` - name: create a network google.cloud.gcp_compute_network: name: network-instancetemplate project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: network - name: create a address google.cloud.gcp_compute_address: name: address-instancetemplate region: us-central1 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: address - name: create a instance template google.cloud.gcp_compute_instance_template: name: "{{ resource_name }}" properties: disks: - auto_delete: 'true' boot: 'true' initialize_params: source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts machine_type: n1-standard-1 network_interfaces: - network: "{{ network }}" access_configs: - name: test-config type: ONE_TO_ONE_NAT nat_ip: "{{ address }}" project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: instancetemplate - name: create a region instance group manager google.cloud.gcp_compute_region_instance_group_manager: name: test_object base_instance_name: test1-child region: us-central1 instance_template: "{{ instancetemplate }}" target_size: 3 project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| autoHealingPolicies complex \| success \| The autohealing policy for this managed instance group . \| \| \| healthCheck string \| success \| The URL for the health check that signals autohealing. \| \| \| initialDelaySec integer \| success \| The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances . \| \| baseInstanceName string \| success \| The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. \| \| creationTimestamp string \| success \| The creation timestamp for this managed instance group in RFC3339 text format. \| \| currentActions complex \| success \| The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. \| \| \| abandoning integer \| success \| The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. \| \| \| creating integer \| success \| The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated. \| \| \| creatingWithoutRetries integer \| success \| The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly. \| \| \| deleting integer \| success \| The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. \| \| \| none integer \| success \| The number of instances in the managed instance group that are running and have no scheduled actions. \| \| \| recreating integer \| success \| The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template. \| \| \| refreshing integer \| success \| The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance. \| \| \| restarting integer \| success \| The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. \| \| description string \| success \| An optional description of this resource. Provide this property when you create the resource. \| \| id integer \| success \| A unique identifier for this resource. \| \| instanceGroup dictionary \| success \| The instance group being managed. \| \| instanceTemplate dictionary \| success \| The instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. \| \| name string \| success \| The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. \| \| namedPorts complex \| success \| Named ports configured for the Instance Groups complementary to this Instance Group Manager. \| \| \| name string \| success \| The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. \| \| \| port integer \| success \| The port number, which can be a value between 1 and 65535. \| \| region string \| success \| The region the managed instance group resides. \| \| targetPools list / elements=string \| success \| TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. \| \| targetSize integer \| success \| The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible Google.Cloud Google.Cloud ============ Collection version 1.0.2 Plugin Index ------------ These are the plugins in the google.cloud collection ### Inventory Plugins * [gcp\_compute](gcp_compute_inventory#ansible-collections-google-cloud-gcp-compute-inventory) – Google Cloud Compute Engine inventory source ### Modules * [gcp\_appengine\_firewall\_rule](gcp_appengine_firewall_rule_module#ansible-collections-google-cloud-gcp-appengine-firewall-rule-module) – Creates a GCP FirewallRule * [gcp\_appengine\_firewall\_rule\_info](gcp_appengine_firewall_rule_info_module#ansible-collections-google-cloud-gcp-appengine-firewall-rule-info-module) – Gather info for GCP FirewallRule * [gcp\_bigquery\_dataset](gcp_bigquery_dataset_module#ansible-collections-google-cloud-gcp-bigquery-dataset-module) – Creates a GCP Dataset * [gcp\_bigquery\_dataset\_info](gcp_bigquery_dataset_info_module#ansible-collections-google-cloud-gcp-bigquery-dataset-info-module) – Gather info for GCP Dataset * [gcp\_bigquery\_table](gcp_bigquery_table_module#ansible-collections-google-cloud-gcp-bigquery-table-module) – Creates a GCP Table * [gcp\_bigquery\_table\_info](gcp_bigquery_table_info_module#ansible-collections-google-cloud-gcp-bigquery-table-info-module) – Gather info for GCP Table * [gcp\_bigtable\_instance](gcp_bigtable_instance_module#ansible-collections-google-cloud-gcp-bigtable-instance-module) – Creates a GCP Instance * [gcp\_bigtable\_instance\_info](gcp_bigtable_instance_info_module#ansible-collections-google-cloud-gcp-bigtable-instance-info-module) – Gather info for GCP Instance * [gcp\_cloudbuild\_trigger](gcp_cloudbuild_trigger_module#ansible-collections-google-cloud-gcp-cloudbuild-trigger-module) – Creates a GCP Trigger * [gcp\_cloudbuild\_trigger\_info](gcp_cloudbuild_trigger_info_module#ansible-collections-google-cloud-gcp-cloudbuild-trigger-info-module) – Gather info for GCP Trigger * [gcp\_cloudfunctions\_cloud\_function](gcp_cloudfunctions_cloud_function_module#ansible-collections-google-cloud-gcp-cloudfunctions-cloud-function-module) – Creates a GCP CloudFunction * [gcp\_cloudfunctions\_cloud\_function\_info](gcp_cloudfunctions_cloud_function_info_module#ansible-collections-google-cloud-gcp-cloudfunctions-cloud-function-info-module) – Gather info for GCP CloudFunction * [gcp\_cloudscheduler\_job](gcp_cloudscheduler_job_module#ansible-collections-google-cloud-gcp-cloudscheduler-job-module) – Creates a GCP Job * [gcp\_cloudscheduler\_job\_info](gcp_cloudscheduler_job_info_module#ansible-collections-google-cloud-gcp-cloudscheduler-job-info-module) – Gather info for GCP Job * [gcp\_cloudtasks\_queue](gcp_cloudtasks_queue_module#ansible-collections-google-cloud-gcp-cloudtasks-queue-module) – Creates a GCP Queue * [gcp\_cloudtasks\_queue\_info](gcp_cloudtasks_queue_info_module#ansible-collections-google-cloud-gcp-cloudtasks-queue-info-module) – Gather info for GCP Queue * [gcp\_compute\_address](gcp_compute_address_module#ansible-collections-google-cloud-gcp-compute-address-module) – Creates a GCP Address * [gcp\_compute\_address\_info](gcp_compute_address_info_module#ansible-collections-google-cloud-gcp-compute-address-info-module) – Gather info for GCP Address * [gcp\_compute\_autoscaler](gcp_compute_autoscaler_module#ansible-collections-google-cloud-gcp-compute-autoscaler-module) – Creates a GCP Autoscaler * [gcp\_compute\_autoscaler\_info](gcp_compute_autoscaler_info_module#ansible-collections-google-cloud-gcp-compute-autoscaler-info-module) – Gather info for GCP Autoscaler * [gcp\_compute\_backend\_bucket](gcp_compute_backend_bucket_module#ansible-collections-google-cloud-gcp-compute-backend-bucket-module) – Creates a GCP BackendBucket * [gcp\_compute\_backend\_bucket\_info](gcp_compute_backend_bucket_info_module#ansible-collections-google-cloud-gcp-compute-backend-bucket-info-module) – Gather info for GCP BackendBucket * [gcp\_compute\_backend\_service](gcp_compute_backend_service_module#ansible-collections-google-cloud-gcp-compute-backend-service-module) – Creates a GCP BackendService * [gcp\_compute\_backend\_service\_info](gcp_compute_backend_service_info_module#ansible-collections-google-cloud-gcp-compute-backend-service-info-module) – Gather info for GCP BackendService * [gcp\_compute\_disk](gcp_compute_disk_module#ansible-collections-google-cloud-gcp-compute-disk-module) – Creates a GCP Disk * [gcp\_compute\_disk\_info](gcp_compute_disk_info_module#ansible-collections-google-cloud-gcp-compute-disk-info-module) – Gather info for GCP Disk * [gcp\_compute\_external\_vpn\_gateway](gcp_compute_external_vpn_gateway_module#ansible-collections-google-cloud-gcp-compute-external-vpn-gateway-module) – Creates a GCP ExternalVpnGateway * [gcp\_compute\_external\_vpn\_gateway\_info](gcp_compute_external_vpn_gateway_info_module#ansible-collections-google-cloud-gcp-compute-external-vpn-gateway-info-module) – Gather info for GCP ExternalVpnGateway * [gcp\_compute\_firewall](gcp_compute_firewall_module#ansible-collections-google-cloud-gcp-compute-firewall-module) – Creates a GCP Firewall * [gcp\_compute\_firewall\_info](gcp_compute_firewall_info_module#ansible-collections-google-cloud-gcp-compute-firewall-info-module) – Gather info for GCP Firewall * [gcp\_compute\_forwarding\_rule](gcp_compute_forwarding_rule_module#ansible-collections-google-cloud-gcp-compute-forwarding-rule-module) – Creates a GCP ForwardingRule * [gcp\_compute\_forwarding\_rule\_info](gcp_compute_forwarding_rule_info_module#ansible-collections-google-cloud-gcp-compute-forwarding-rule-info-module) – Gather info for GCP ForwardingRule * [gcp\_compute\_global\_address](gcp_compute_global_address_module#ansible-collections-google-cloud-gcp-compute-global-address-module) – Creates a GCP GlobalAddress * [gcp\_compute\_global\_address\_info](gcp_compute_global_address_info_module#ansible-collections-google-cloud-gcp-compute-global-address-info-module) – Gather info for GCP GlobalAddress * [gcp\_compute\_global\_forwarding\_rule](gcp_compute_global_forwarding_rule_module#ansible-collections-google-cloud-gcp-compute-global-forwarding-rule-module) – Creates a GCP GlobalForwardingRule * [gcp\_compute\_global\_forwarding\_rule\_info](gcp_compute_global_forwarding_rule_info_module#ansible-collections-google-cloud-gcp-compute-global-forwarding-rule-info-module) – Gather info for GCP GlobalForwardingRule * [gcp\_compute\_health\_check](gcp_compute_health_check_module#ansible-collections-google-cloud-gcp-compute-health-check-module) – Creates a GCP HealthCheck * [gcp\_compute\_health\_check\_info](gcp_compute_health_check_info_module#ansible-collections-google-cloud-gcp-compute-health-check-info-module) – Gather info for GCP HealthCheck * [gcp\_compute\_http\_health\_check](gcp_compute_http_health_check_module#ansible-collections-google-cloud-gcp-compute-http-health-check-module) – Creates a GCP HttpHealthCheck * [gcp\_compute\_http\_health\_check\_info](gcp_compute_http_health_check_info_module#ansible-collections-google-cloud-gcp-compute-http-health-check-info-module) – Gather info for GCP HttpHealthCheck * [gcp\_compute\_https\_health\_check](gcp_compute_https_health_check_module#ansible-collections-google-cloud-gcp-compute-https-health-check-module) – Creates a GCP HttpsHealthCheck * [gcp\_compute\_https\_health\_check\_info](gcp_compute_https_health_check_info_module#ansible-collections-google-cloud-gcp-compute-https-health-check-info-module) – Gather info for GCP HttpsHealthCheck * [gcp\_compute\_image](gcp_compute_image_module#ansible-collections-google-cloud-gcp-compute-image-module) – Creates a GCP Image * [gcp\_compute\_image\_info](gcp_compute_image_info_module#ansible-collections-google-cloud-gcp-compute-image-info-module) – Gather info for GCP Image * [gcp\_compute\_instance](gcp_compute_instance_module#ansible-collections-google-cloud-gcp-compute-instance-module) – Creates a GCP Instance * [gcp\_compute\_instance\_group](gcp_compute_instance_group_module#ansible-collections-google-cloud-gcp-compute-instance-group-module) – Creates a GCP InstanceGroup * [gcp\_compute\_instance\_group\_info](gcp_compute_instance_group_info_module#ansible-collections-google-cloud-gcp-compute-instance-group-info-module) – Gather info for GCP InstanceGroup * [gcp\_compute\_instance\_group\_manager](gcp_compute_instance_group_manager_module#ansible-collections-google-cloud-gcp-compute-instance-group-manager-module) – Creates a GCP InstanceGroupManager * [gcp\_compute\_instance\_group\_manager\_info](gcp_compute_instance_group_manager_info_module#ansible-collections-google-cloud-gcp-compute-instance-group-manager-info-module) – Gather info for GCP InstanceGroupManager * [gcp\_compute\_instance\_info](gcp_compute_instance_info_module#ansible-collections-google-cloud-gcp-compute-instance-info-module) – Gather info for GCP Instance * [gcp\_compute\_instance\_template](gcp_compute_instance_template_module#ansible-collections-google-cloud-gcp-compute-instance-template-module) – Creates a GCP InstanceTemplate * [gcp\_compute\_instance\_template\_info](gcp_compute_instance_template_info_module#ansible-collections-google-cloud-gcp-compute-instance-template-info-module) – Gather info for GCP InstanceTemplate * [gcp\_compute\_interconnect\_attachment](gcp_compute_interconnect_attachment_module#ansible-collections-google-cloud-gcp-compute-interconnect-attachment-module) – Creates a GCP InterconnectAttachment * [gcp\_compute\_interconnect\_attachment\_info](gcp_compute_interconnect_attachment_info_module#ansible-collections-google-cloud-gcp-compute-interconnect-attachment-info-module) – Gather info for GCP InterconnectAttachment * [gcp\_compute\_network](gcp_compute_network_module#ansible-collections-google-cloud-gcp-compute-network-module) – Creates a GCP Network * [gcp\_compute\_network\_endpoint\_group](gcp_compute_network_endpoint_group_module#ansible-collections-google-cloud-gcp-compute-network-endpoint-group-module) – Creates a GCP NetworkEndpointGroup * [gcp\_compute\_network\_endpoint\_group\_info](gcp_compute_network_endpoint_group_info_module#ansible-collections-google-cloud-gcp-compute-network-endpoint-group-info-module) – Gather info for GCP NetworkEndpointGroup * [gcp\_compute\_network\_info](gcp_compute_network_info_module#ansible-collections-google-cloud-gcp-compute-network-info-module) – Gather info for GCP Network * [gcp\_compute\_node\_group](gcp_compute_node_group_module#ansible-collections-google-cloud-gcp-compute-node-group-module) – Creates a GCP NodeGroup * [gcp\_compute\_node\_group\_info](gcp_compute_node_group_info_module#ansible-collections-google-cloud-gcp-compute-node-group-info-module) – Gather info for GCP NodeGroup * [gcp\_compute\_node\_template](gcp_compute_node_template_module#ansible-collections-google-cloud-gcp-compute-node-template-module) – Creates a GCP NodeTemplate * [gcp\_compute\_node\_template\_info](gcp_compute_node_template_info_module#ansible-collections-google-cloud-gcp-compute-node-template-info-module) – Gather info for GCP NodeTemplate * [gcp\_compute\_region\_autoscaler](gcp_compute_region_autoscaler_module#ansible-collections-google-cloud-gcp-compute-region-autoscaler-module) – Creates a GCP RegionAutoscaler * [gcp\_compute\_region\_autoscaler\_info](gcp_compute_region_autoscaler_info_module#ansible-collections-google-cloud-gcp-compute-region-autoscaler-info-module) – Gather info for GCP RegionAutoscaler * [gcp\_compute\_region\_backend\_service](gcp_compute_region_backend_service_module#ansible-collections-google-cloud-gcp-compute-region-backend-service-module) – Creates a GCP RegionBackendService * [gcp\_compute\_region\_backend\_service\_info](gcp_compute_region_backend_service_info_module#ansible-collections-google-cloud-gcp-compute-region-backend-service-info-module) – Gather info for GCP RegionBackendService * [gcp\_compute\_region\_disk](gcp_compute_region_disk_module#ansible-collections-google-cloud-gcp-compute-region-disk-module) – Creates a GCP RegionDisk * [gcp\_compute\_region\_disk\_info](gcp_compute_region_disk_info_module#ansible-collections-google-cloud-gcp-compute-region-disk-info-module) – Gather info for GCP RegionDisk * [gcp\_compute\_region\_health\_check](gcp_compute_region_health_check_module#ansible-collections-google-cloud-gcp-compute-region-health-check-module) – Creates a GCP RegionHealthCheck * [gcp\_compute\_region\_health\_check\_info](gcp_compute_region_health_check_info_module#ansible-collections-google-cloud-gcp-compute-region-health-check-info-module) – Gather info for GCP RegionHealthCheck * [gcp\_compute\_region\_instance\_group\_manager](gcp_compute_region_instance_group_manager_module#ansible-collections-google-cloud-gcp-compute-region-instance-group-manager-module) – Creates a GCP RegionInstanceGroupManager * [gcp\_compute\_region\_instance\_group\_manager\_info](gcp_compute_region_instance_group_manager_info_module#ansible-collections-google-cloud-gcp-compute-region-instance-group-manager-info-module) – Gather info for GCP RegionInstanceGroupManager * [gcp\_compute\_region\_target\_http\_proxy](gcp_compute_region_target_http_proxy_module#ansible-collections-google-cloud-gcp-compute-region-target-http-proxy-module) – Creates a GCP RegionTargetHttpProxy * [gcp\_compute\_region\_target\_http\_proxy\_info](gcp_compute_region_target_http_proxy_info_module#ansible-collections-google-cloud-gcp-compute-region-target-http-proxy-info-module) – Gather info for GCP RegionTargetHttpProxy * [gcp\_compute\_region\_target\_https\_proxy](gcp_compute_region_target_https_proxy_module#ansible-collections-google-cloud-gcp-compute-region-target-https-proxy-module) – Creates a GCP RegionTargetHttpsProxy * [gcp\_compute\_region\_target\_https\_proxy\_info](gcp_compute_region_target_https_proxy_info_module#ansible-collections-google-cloud-gcp-compute-region-target-https-proxy-info-module) – Gather info for GCP RegionTargetHttpsProxy * [gcp\_compute\_region\_url\_map](gcp_compute_region_url_map_module#ansible-collections-google-cloud-gcp-compute-region-url-map-module) – Creates a GCP RegionUrlMap * [gcp\_compute\_region\_url\_map\_info](gcp_compute_region_url_map_info_module#ansible-collections-google-cloud-gcp-compute-region-url-map-info-module) – Gather info for GCP RegionUrlMap * [gcp\_compute\_reservation](gcp_compute_reservation_module#ansible-collections-google-cloud-gcp-compute-reservation-module) – Creates a GCP Reservation * [gcp\_compute\_reservation\_info](gcp_compute_reservation_info_module#ansible-collections-google-cloud-gcp-compute-reservation-info-module) – Gather info for GCP Reservation * [gcp\_compute\_resource\_policy](gcp_compute_resource_policy_module#ansible-collections-google-cloud-gcp-compute-resource-policy-module) – Creates a GCP ResourcePolicy * [gcp\_compute\_resource\_policy\_info](gcp_compute_resource_policy_info_module#ansible-collections-google-cloud-gcp-compute-resource-policy-info-module) – Gather info for GCP ResourcePolicy * [gcp\_compute\_route](gcp_compute_route_module#ansible-collections-google-cloud-gcp-compute-route-module) – Creates a GCP Route * [gcp\_compute\_route\_info](gcp_compute_route_info_module#ansible-collections-google-cloud-gcp-compute-route-info-module) – Gather info for GCP Route * [gcp\_compute\_router](gcp_compute_router_module#ansible-collections-google-cloud-gcp-compute-router-module) – Creates a GCP Router * [gcp\_compute\_router\_info](gcp_compute_router_info_module#ansible-collections-google-cloud-gcp-compute-router-info-module) – Gather info for GCP Router * [gcp\_compute\_snapshot](gcp_compute_snapshot_module#ansible-collections-google-cloud-gcp-compute-snapshot-module) – Creates a GCP Snapshot * [gcp\_compute\_snapshot\_info](gcp_compute_snapshot_info_module#ansible-collections-google-cloud-gcp-compute-snapshot-info-module) – Gather info for GCP Snapshot * [gcp\_compute\_ssl\_certificate](gcp_compute_ssl_certificate_module#ansible-collections-google-cloud-gcp-compute-ssl-certificate-module) – Creates a GCP SslCertificate * [gcp\_compute\_ssl\_certificate\_info](gcp_compute_ssl_certificate_info_module#ansible-collections-google-cloud-gcp-compute-ssl-certificate-info-module) – Gather info for GCP SslCertificate * [gcp\_compute\_ssl\_policy](gcp_compute_ssl_policy_module#ansible-collections-google-cloud-gcp-compute-ssl-policy-module) – Creates a GCP SslPolicy * [gcp\_compute\_ssl\_policy\_info](gcp_compute_ssl_policy_info_module#ansible-collections-google-cloud-gcp-compute-ssl-policy-info-module) – Gather info for GCP SslPolicy * [gcp\_compute\_subnetwork](gcp_compute_subnetwork_module#ansible-collections-google-cloud-gcp-compute-subnetwork-module) – Creates a GCP Subnetwork * [gcp\_compute\_subnetwork\_info](gcp_compute_subnetwork_info_module#ansible-collections-google-cloud-gcp-compute-subnetwork-info-module) – Gather info for GCP Subnetwork * [gcp\_compute\_target\_http\_proxy](gcp_compute_target_http_proxy_module#ansible-collections-google-cloud-gcp-compute-target-http-proxy-module) – Creates a GCP TargetHttpProxy * [gcp\_compute\_target\_http\_proxy\_info](gcp_compute_target_http_proxy_info_module#ansible-collections-google-cloud-gcp-compute-target-http-proxy-info-module) – Gather info for GCP TargetHttpProxy * [gcp\_compute\_target\_https\_proxy](gcp_compute_target_https_proxy_module#ansible-collections-google-cloud-gcp-compute-target-https-proxy-module) – Creates a GCP TargetHttpsProxy * [gcp\_compute\_target\_https\_proxy\_info](gcp_compute_target_https_proxy_info_module#ansible-collections-google-cloud-gcp-compute-target-https-proxy-info-module) – Gather info for GCP TargetHttpsProxy * [gcp\_compute\_target\_instance](gcp_compute_target_instance_module#ansible-collections-google-cloud-gcp-compute-target-instance-module) – Creates a GCP TargetInstance * [gcp\_compute\_target\_instance\_info](gcp_compute_target_instance_info_module#ansible-collections-google-cloud-gcp-compute-target-instance-info-module) – Gather info for GCP TargetInstance * [gcp\_compute\_target\_pool](gcp_compute_target_pool_module#ansible-collections-google-cloud-gcp-compute-target-pool-module) – Creates a GCP TargetPool * [gcp\_compute\_target\_pool\_info](gcp_compute_target_pool_info_module#ansible-collections-google-cloud-gcp-compute-target-pool-info-module) – Gather info for GCP TargetPool * [gcp\_compute\_target\_ssl\_proxy](gcp_compute_target_ssl_proxy_module#ansible-collections-google-cloud-gcp-compute-target-ssl-proxy-module) – Creates a GCP TargetSslProxy * [gcp\_compute\_target\_ssl\_proxy\_info](gcp_compute_target_ssl_proxy_info_module#ansible-collections-google-cloud-gcp-compute-target-ssl-proxy-info-module) – Gather info for GCP TargetSslProxy * [gcp\_compute\_target\_tcp\_proxy](gcp_compute_target_tcp_proxy_module#ansible-collections-google-cloud-gcp-compute-target-tcp-proxy-module) – Creates a GCP TargetTcpProxy * [gcp\_compute\_target\_tcp\_proxy\_info](gcp_compute_target_tcp_proxy_info_module#ansible-collections-google-cloud-gcp-compute-target-tcp-proxy-info-module) – Gather info for GCP TargetTcpProxy * [gcp\_compute\_target\_vpn\_gateway](gcp_compute_target_vpn_gateway_module#ansible-collections-google-cloud-gcp-compute-target-vpn-gateway-module) – Creates a GCP TargetVpnGateway * [gcp\_compute\_target\_vpn\_gateway\_info](gcp_compute_target_vpn_gateway_info_module#ansible-collections-google-cloud-gcp-compute-target-vpn-gateway-info-module) – Gather info for GCP TargetVpnGateway * [gcp\_compute\_url\_map](gcp_compute_url_map_module#ansible-collections-google-cloud-gcp-compute-url-map-module) – Creates a GCP UrlMap * [gcp\_compute\_url\_map\_info](gcp_compute_url_map_info_module#ansible-collections-google-cloud-gcp-compute-url-map-info-module) – Gather info for GCP UrlMap * [gcp\_compute\_vpn\_tunnel](gcp_compute_vpn_tunnel_module#ansible-collections-google-cloud-gcp-compute-vpn-tunnel-module) – Creates a GCP VpnTunnel * [gcp\_compute\_vpn\_tunnel\_info](gcp_compute_vpn_tunnel_info_module#ansible-collections-google-cloud-gcp-compute-vpn-tunnel-info-module) – Gather info for GCP VpnTunnel * [gcp\_container\_cluster](gcp_container_cluster_module#ansible-collections-google-cloud-gcp-container-cluster-module) – Creates a GCP Cluster * [gcp\_container\_cluster\_info](gcp_container_cluster_info_module#ansible-collections-google-cloud-gcp-container-cluster-info-module) – Gather info for GCP Cluster * [gcp\_container\_node\_pool](gcp_container_node_pool_module#ansible-collections-google-cloud-gcp-container-node-pool-module) – Creates a GCP NodePool * [gcp\_container\_node\_pool\_info](gcp_container_node_pool_info_module#ansible-collections-google-cloud-gcp-container-node-pool-info-module) – Gather info for GCP NodePool * [gcp\_dns\_managed\_zone](gcp_dns_managed_zone_module#ansible-collections-google-cloud-gcp-dns-managed-zone-module) – Creates a GCP ManagedZone * [gcp\_dns\_managed\_zone\_info](gcp_dns_managed_zone_info_module#ansible-collections-google-cloud-gcp-dns-managed-zone-info-module) – Gather info for GCP ManagedZone * [gcp\_dns\_resource\_record\_set](gcp_dns_resource_record_set_module#ansible-collections-google-cloud-gcp-dns-resource-record-set-module) – Creates a GCP ResourceRecordSet * [gcp\_dns\_resource\_record\_set\_info](gcp_dns_resource_record_set_info_module#ansible-collections-google-cloud-gcp-dns-resource-record-set-info-module) – Gather info for GCP ResourceRecordSet * [gcp\_filestore\_instance](gcp_filestore_instance_module#ansible-collections-google-cloud-gcp-filestore-instance-module) – Creates a GCP Instance * [gcp\_filestore\_instance\_info](gcp_filestore_instance_info_module#ansible-collections-google-cloud-gcp-filestore-instance-info-module) – Gather info for GCP Instance * [gcp\_iam\_role](gcp_iam_role_module#ansible-collections-google-cloud-gcp-iam-role-module) – Creates a GCP Role * [gcp\_iam\_role\_info](gcp_iam_role_info_module#ansible-collections-google-cloud-gcp-iam-role-info-module) – Gather info for GCP Role * [gcp\_iam\_service\_account](gcp_iam_service_account_module#ansible-collections-google-cloud-gcp-iam-service-account-module) – Creates a GCP ServiceAccount * [gcp\_iam\_service\_account\_info](gcp_iam_service_account_info_module#ansible-collections-google-cloud-gcp-iam-service-account-info-module) – Gather info for GCP ServiceAccount * [gcp\_iam\_service\_account\_key](gcp_iam_service_account_key_module#ansible-collections-google-cloud-gcp-iam-service-account-key-module) – Creates a GCP ServiceAccountKey * [gcp\_kms\_crypto\_key](gcp_kms_crypto_key_module#ansible-collections-google-cloud-gcp-kms-crypto-key-module) – Creates a GCP CryptoKey * [gcp\_kms\_crypto\_key\_info](gcp_kms_crypto_key_info_module#ansible-collections-google-cloud-gcp-kms-crypto-key-info-module) – Gather info for GCP CryptoKey * [gcp\_kms\_key\_ring](gcp_kms_key_ring_module#ansible-collections-google-cloud-gcp-kms-key-ring-module) – Creates a GCP KeyRing * [gcp\_kms\_key\_ring\_info](gcp_kms_key_ring_info_module#ansible-collections-google-cloud-gcp-kms-key-ring-info-module) – Gather info for GCP KeyRing * [gcp\_logging\_metric](gcp_logging_metric_module#ansible-collections-google-cloud-gcp-logging-metric-module) – Creates a GCP Metric * [gcp\_logging\_metric\_info](gcp_logging_metric_info_module#ansible-collections-google-cloud-gcp-logging-metric-info-module) – Gather info for GCP Metric * [gcp\_mlengine\_model](gcp_mlengine_model_module#ansible-collections-google-cloud-gcp-mlengine-model-module) – Creates a GCP Model * [gcp\_mlengine\_model\_info](gcp_mlengine_model_info_module#ansible-collections-google-cloud-gcp-mlengine-model-info-module) – Gather info for GCP Model * [gcp\_mlengine\_version](gcp_mlengine_version_module#ansible-collections-google-cloud-gcp-mlengine-version-module) – Creates a GCP Version * [gcp\_mlengine\_version\_info](gcp_mlengine_version_info_module#ansible-collections-google-cloud-gcp-mlengine-version-info-module) – Gather info for GCP Version * [gcp\_pubsub\_subscription](gcp_pubsub_subscription_module#ansible-collections-google-cloud-gcp-pubsub-subscription-module) – Creates a GCP Subscription * [gcp\_pubsub\_subscription\_info](gcp_pubsub_subscription_info_module#ansible-collections-google-cloud-gcp-pubsub-subscription-info-module) – Gather info for GCP Subscription * [gcp\_pubsub\_topic](gcp_pubsub_topic_module#ansible-collections-google-cloud-gcp-pubsub-topic-module) – Creates a GCP Topic * [gcp\_pubsub\_topic\_info](gcp_pubsub_topic_info_module#ansible-collections-google-cloud-gcp-pubsub-topic-info-module) – Gather info for GCP Topic * [gcp\_redis\_instance](gcp_redis_instance_module#ansible-collections-google-cloud-gcp-redis-instance-module) – Creates a GCP Instance * [gcp\_redis\_instance\_info](gcp_redis_instance_info_module#ansible-collections-google-cloud-gcp-redis-instance-info-module) – Gather info for GCP Instance * [gcp\_resourcemanager\_project](gcp_resourcemanager_project_module#ansible-collections-google-cloud-gcp-resourcemanager-project-module) – Creates a GCP Project * [gcp\_resourcemanager\_project\_info](gcp_resourcemanager_project_info_module#ansible-collections-google-cloud-gcp-resourcemanager-project-info-module) – Gather info for GCP Project * [gcp\_runtimeconfig\_config](gcp_runtimeconfig_config_module#ansible-collections-google-cloud-gcp-runtimeconfig-config-module) – Creates a GCP Config * [gcp\_runtimeconfig\_config\_info](gcp_runtimeconfig_config_info_module#ansible-collections-google-cloud-gcp-runtimeconfig-config-info-module) – Gather info for GCP Config * [gcp\_runtimeconfig\_variable](gcp_runtimeconfig_variable_module#ansible-collections-google-cloud-gcp-runtimeconfig-variable-module) – Creates a GCP Variable * [gcp\_runtimeconfig\_variable\_info](gcp_runtimeconfig_variable_info_module#ansible-collections-google-cloud-gcp-runtimeconfig-variable-info-module) – Gather info for GCP Variable * [gcp\_serviceusage\_service](gcp_serviceusage_service_module#ansible-collections-google-cloud-gcp-serviceusage-service-module) – Creates a GCP Service * [gcp\_serviceusage\_service\_info](gcp_serviceusage_service_info_module#ansible-collections-google-cloud-gcp-serviceusage-service-info-module) – Gather info for GCP Service * [gcp\_sourcerepo\_repository](gcp_sourcerepo_repository_module#ansible-collections-google-cloud-gcp-sourcerepo-repository-module) – Creates a GCP Repository * [gcp\_sourcerepo\_repository\_info](gcp_sourcerepo_repository_info_module#ansible-collections-google-cloud-gcp-sourcerepo-repository-info-module) – Gather info for GCP Repository * [gcp\_spanner\_database](gcp_spanner_database_module#ansible-collections-google-cloud-gcp-spanner-database-module) – Creates a GCP Database * [gcp\_spanner\_database\_info](gcp_spanner_database_info_module#ansible-collections-google-cloud-gcp-spanner-database-info-module) – Gather info for GCP Database * [gcp\_spanner\_instance](gcp_spanner_instance_module#ansible-collections-google-cloud-gcp-spanner-instance-module) – Creates a GCP Instance * [gcp\_spanner\_instance\_info](gcp_spanner_instance_info_module#ansible-collections-google-cloud-gcp-spanner-instance-info-module) – Gather info for GCP Instance * [gcp\_sql\_database](gcp_sql_database_module#ansible-collections-google-cloud-gcp-sql-database-module) – Creates a GCP Database * [gcp\_sql\_database\_info](gcp_sql_database_info_module#ansible-collections-google-cloud-gcp-sql-database-info-module) – Gather info for GCP Database * [gcp\_sql\_instance](gcp_sql_instance_module#ansible-collections-google-cloud-gcp-sql-instance-module) – Creates a GCP Instance * [gcp\_sql\_instance\_info](gcp_sql_instance_info_module#ansible-collections-google-cloud-gcp-sql-instance-info-module) – Gather info for GCP Instance * [gcp\_sql\_ssl\_cert](gcp_sql_ssl_cert_module#ansible-collections-google-cloud-gcp-sql-ssl-cert-module) – Creates a GCP SslCert * [gcp\_sql\_user](gcp_sql_user_module#ansible-collections-google-cloud-gcp-sql-user-module) – Creates a GCP User * [gcp\_sql\_user\_info](gcp_sql_user_info_module#ansible-collections-google-cloud-gcp-sql-user-info-module) – Gather info for GCP User * [gcp\_storage\_bucket](gcp_storage_bucket_module#ansible-collections-google-cloud-gcp-storage-bucket-module) – Creates a GCP Bucket * [gcp\_storage\_bucket\_access\_control](gcp_storage_bucket_access_control_module#ansible-collections-google-cloud-gcp-storage-bucket-access-control-module) – Creates a GCP BucketAccessControl * [gcp\_storage\_default\_object\_acl](gcp_storage_default_object_acl_module#ansible-collections-google-cloud-gcp-storage-default-object-acl-module) – Creates a GCP DefaultObjectACL * [gcp\_storage\_object](gcp_storage_object_module#ansible-collections-google-cloud-gcp-storage-object-module) – Creates a GCP Object * [gcp\_tpu\_node](gcp_tpu_node_module#ansible-collections-google-cloud-gcp-tpu-node-module) – Creates a GCP Node * [gcp\_tpu\_node\_info](gcp_tpu_node_info_module#ansible-collections-google-cloud-gcp-tpu-node-info-module) – Gather info for GCP Node See also List of [collections](../../index#list-of-collections) with docs hosted here.	programming_docs
ansible google.cloud.gcp_compute_target_vpn_gateway_info – Gather info for GCP TargetVpnGateway google.cloud.gcp\_compute\_target\_vpn\_gateway\_info – Gather info for GCP TargetVpnGateway ============================================================================================ Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_target_vpn_gateway_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP TargetVpnGateway Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| filters list / elements=string \| \| A list of filter value pairs. Available filters are listed here <https://cloud.google.com/sdk/gcloud/reference/topic/filters>. Each additional filter in the list will act be added as an AND condition (filter1 and filter2) . \| \| project string \| \| The Google Cloud Platform project to use. \| \| region string / required \| \| The region this gateway should sit in. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a target vpn gateway gcp_compute_target_vpn_gateway_info: region: us-west1 filters: - name = test_object project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| \| description string \| success \| An optional description of this resource. \| \| \| forwardingRules list / elements=string \| success \| A list of references to the ForwardingRule resources associated with this VPN gateway. \| \| \| id integer \| success \| The unique identifier for the resource. \| \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| \| network* dictionary \| success \| The network this VPN gateway is accepting traffic for. \| \| \| region string \| success \| The region this gateway should sit in. \| \| \| tunnels list / elements=string \| success \| A list of references to VpnTunnel resources associated with this VPN gateway. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_container_node_pool – Creates a GCP NodePool google.cloud.gcp\_container\_node\_pool – Creates a GCP NodePool ================================================================ Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_container_node_pool`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * NodePool contains the name and configuration for a cluster’s node pool. * Node pools are a set of nodes (i.e. VM’s), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| autoscaling dictionary \| \| Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. \| \| \| enabled boolean \| Choices:* no * yes \| Is autoscaling enabled for this node pool. \| \| \| max\_node\_count integer \| \| Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. \| \| \| min\_node\_count integer \| \| Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. \| \| cluster dictionary / required \| \| The cluster this node pool belongs to. This field represents a link to a Cluster resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'name' and value of your resource's name Alternatively, you can add `register: name-of-resource` to a gcp\_container\_cluster task and then set this cluster field to "{{ name-of-resource }}" \| \| conditions list / elements=dictionary \| \| Which conditions caused the current node pool state. \| \| \| code string \| \| Machine-friendly representation of the condition. Some valid choices include: "UNKNOWN", "GCE\_STOCKOUT", "GKE\_SERVICE\_ACCOUNT\_DELETED", "GCE\_QUOTA\_EXCEEDED", "SET\_BY\_OPERATOR" \| \| config dictionary \| \| The node configuration of the pool. \| \| \| accelerators list / elements=dictionary \| \| A list of hardware accelerators to be attached to each node. \| \| \| \| accelerator\_count integer \| \| The number of the accelerator cards exposed to an instance. \| \| \| \| accelerator\_type string \| \| The accelerator type resource name. \| \| \| disk\_size\_gb integer \| \| Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. \| \| \| disk\_type string \| \| Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard' . \| \| \| image\_type string \| \| The image type to use for this node. Note that for a given image type, the latest version of it will be used. \| \| \| labels dictionary \| \| The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: <http://kubernetes.io/v1.1/docs/user-guide/labels.html> An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. \| \| \| local\_ssd\_count integer \| \| The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: <https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits> for more information. \| \| \| machine\_type string \| \| The name of a Google Compute Engine machine type (e.g. n1-standard-1). If unspecified, the default machine type is n1-standard-1. \| \| \| metadata dictionary \| \| The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-\_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. \| \| \| min\_cpu\_platform string \| \| Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform . \| \| \| oauth\_scopes list / elements=string \| \| The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: <https://www.googleapis.com/auth/compute> is required for mounting persistent storage on your nodes. <https://www.googleapis.com/auth/devstorage.read_only> is required for communicating with gcr.io (the Google Container Registry). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. \| \| \| preemptible boolean \| Choices:* no * yes \| Whether the nodes are created as preemptible VM instances. See: <https://cloud.google.com/compute/docs/instances/preemptible> for more information about preemptible VM instances. \| \| \| service\_account string \| \| The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. \| \| \| shielded\_instance\_config dictionary \| \| Shielded Instance options. \| \| \| \| enable\_integrity\_monitoring boolean \| Choices:* no * yes \| Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. \| \| \| \| enable\_secure\_boot boolean \| Choices:* no * yes \| Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. \| \| \| tags list / elements=string \| \| The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. \| \| \| taints list / elements=dictionary \| \| List of kubernetes taints to be applied to each node. \| \| \| \| effect string \| \| Effect for taint. \| \| \| \| key string \| \| Key for taint. \| \| \| \| value string \| \| Value for taint. \| \| \| workload\_meta\_config dictionary \| \| WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. \| \| \| \| mode string \| \| Mode is the configuration for how to expose metadata to workloads running on the node pool. Some valid choices include: "GCE\_METADATA", "GKE\_METADATA" \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| initial\_node\_count integer / required \| \| The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. \| \| location string / required \| \| The location where the node pool is deployed. aliases: region, zone \| \| management dictionary \| \| Management configuration for this NodePool. \| \| \| auto\_repair boolean \| Choices:* no * yes \| A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. \| \| \| auto\_upgrade boolean \| Choices:* no * yes \| A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. \| \| \| upgrade\_options dictionary \| \| Specifies the Auto Upgrade knobs for the node pool. \| \| max\_pods\_constraint dictionary \| \| The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. \| \| \| max\_pods\_per\_node integer \| \| Constraint enforced on the max num of pods per node. \| \| name string \| \| The name of the node pool. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| version string \| \| The version of the Kubernetes of this node. \| Examples -------- ``` - name: create a cluster google.cloud.gcp_container_cluster: name: cluster-nodepool initial_node_count: 4 location: us-central1-a project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: cluster - name: create a node pool google.cloud.gcp_container_node_pool: name: my-pool initial_node_count: 4 cluster: "{{ cluster }}" location: us-central1-a project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| autoscaling complex \| success \| Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. \| \| \| enabled boolean \| success \| Is autoscaling enabled for this node pool. \| \| \| maxNodeCount integer \| success \| Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. \| \| \| minNodeCount integer \| success \| Minimum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. \| \| cluster dictionary \| success \| The cluster this node pool belongs to. \| \| conditions complex \| success \| Which conditions caused the current node pool state. \| \| \| code string \| success \| Machine-friendly representation of the condition. \| \| config complex \| success \| The node configuration of the pool. \| \| \| accelerators complex \| success \| A list of hardware accelerators to be attached to each node. \| \| \| \| acceleratorCount integer \| success \| The number of the accelerator cards exposed to an instance. \| \| \| \| acceleratorType string \| success \| The accelerator type resource name. \| \| \| diskSizeGb integer \| success \| Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. \| \| \| diskType string \| success \| Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') If unspecified, the default disk type is 'pd-standard' . \| \| \| imageType string \| success \| The image type to use for this node. Note that for a given image type, the latest version of it will be used. \| \| \| labels dictionary \| success \| The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: <http://kubernetes.io/v1.1/docs/user-guide/labels.html> An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. \| \| \| localSsdCount integer \| success \| The number of local SSD disks to be attached to the node. The limit for this value is dependant upon the maximum number of disks available on a machine per zone. See: <https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits> for more information. \| \| \| machineType string \| success \| The name of a Google Compute Engine machine type (e.g. n1-standard-1). If unspecified, the default machine type is n1-standard-1. \| \| \| metadata dictionary \| success \| The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-\_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the four reserved keys: "instance-template", "kube-env", "startup-script", and "user-data" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. \| \| \| minCpuPlatform string \| success \| Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform . \| \| \| oauthScopes list / elements=string \| success \| The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: <https://www.googleapis.com/auth/compute> is required for mounting persistent storage on your nodes. <https://www.googleapis.com/auth/devstorage.read_only> is required for communicating with gcr.io (the Google Container Registry). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. \| \| \| preemptible boolean \| success \| Whether the nodes are created as preemptible VM instances. See: <https://cloud.google.com/compute/docs/instances/preemptible> for more information about preemptible VM instances. \| \| \| serviceAccount string \| success \| The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. \| \| \| shieldedInstanceConfig complex \| success \| Shielded Instance options. \| \| \| \| enableIntegrityMonitoring boolean \| success \| Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. \| \| \| \| enableSecureBoot boolean \| success \| Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. \| \| \| tags list / elements=string \| success \| The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. \| \| \| taints complex \| success \| List of kubernetes taints to be applied to each node. \| \| \| \| effect string \| success \| Effect for taint. \| \| \| \| key string \| success \| Key for taint. \| \| \| \| value string \| success \| Value for taint. \| \| \| workloadMetaConfig complex \| success \| WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. \| \| \| \| mode string \| success \| Mode is the configuration for how to expose metadata to workloads running on the node pool. \| \| initialNodeCount integer \| success \| The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. \| \| location string \| success \| The location where the node pool is deployed. \| \| management complex \| success \| Management configuration for this NodePool. \| \| \| autoRepair boolean \| success \| A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. \| \| \| autoUpgrade boolean \| success \| A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. \| \| \| upgradeOptions complex \| success \| Specifies the Auto Upgrade knobs for the node pool. \| \| \| \| autoUpgradeStartTime string \| success \| This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format. \| \| \| \| description string \| success \| This field is set when upgrades are about to commence with the description of the upgrade. \| \| maxPodsConstraint complex \| success \| The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. \| \| \| maxPodsPerNode integer \| success \| Constraint enforced on the max num of pods per node. \| \| name string \| success \| The name of the node pool. \| \| podIpv4CidrSize integer \| success \| The pod CIDR block size per node in this node pool. \| \| status string \| success \| Status of nodes in this pool instance. \| \| statusMessage string \| success \| Additional information about the current status of this node pool instance. \| \| version string \| success \| The version of the Kubernetes of this node. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_compute_target_http_proxy – Creates a GCP TargetHttpProxy google.cloud.gcp\_compute\_target\_http\_proxy – Creates a GCP TargetHttpProxy ============================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_target_http_proxy`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Represents a TargetHttpProxy resource, which is used by one or more global forwarding rule to route incoming HTTP requests to a URL map. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| description string \| \| An optional description of this resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| project* string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| url\_map dictionary / required \| \| A reference to the UrlMap resource that defines the mapping from URL to the BackendService. This field represents a link to a UrlMap resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_url\_map task and then set this url\_map field to "{{ name-of-resource }}" \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/v1/targetHttpProxies> * Official Documentation: <https://cloud.google.com/compute/docs/load-balancing/http/target-proxies> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a instance group google.cloud.gcp_compute_instance_group: name: instancegroup-targethttpproxy zone: us-central1-a project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: instancegroup - name: create a HTTP health check google.cloud.gcp_compute_http_health_check: name: httphealthcheck-targethttpproxy healthy_threshold: 10 port: 8080 timeout_sec: 2 unhealthy_threshold: 5 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: healthcheck - name: create a backend service google.cloud.gcp_compute_backend_service: name: backendservice-targethttpproxy backends: - group: "{{ instancegroup.selfLink }}" health_checks: - "{{ healthcheck.selfLink }}" enable_cdn: 'true' project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: backendservice - name: create a URL map google.cloud.gcp_compute_url_map: name: urlmap-targethttpproxy default_service: "{{ backendservice }}" project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: urlmap - name: create a target HTTP proxy google.cloud.gcp_compute_target_http_proxy: name: test_object url_map: "{{ urlmap }}" project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. \| \| id integer \| success \| The unique identifier for the resource. \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| urlMap* dictionary \| success \| A reference to the UrlMap resource that defines the mapping from URL to the BackendService. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_runtimeconfig_config_info – Gather info for GCP Config google.cloud.gcp\_runtimeconfig\_config\_info – Gather info for GCP Config ========================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_runtimeconfig_config_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Gather info for GCP Config Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| Notes ----- Note * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: get info on a config gcp_runtimeconfig_config_info: project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| resources complex \| always \| List of resources \| \| \| description string \| success \| The description to associate with the runtime config. \| \| \| name string \| success \| The name of the runtime config. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_target_ssl_proxy – Creates a GCP TargetSslProxy google.cloud.gcp\_compute\_target\_ssl\_proxy – Creates a GCP TargetSslProxy ============================================================================ Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_target_ssl_proxy`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Represents a TargetSslProxy resource, which is used by one or more global forwarding rule to route incoming SSL requests to a backend service. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| description string \| \| An optional description of this resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| project* string \| \| The Google Cloud Platform project to use. \| \| proxy\_header string \| \| Specifies the type of proxy header to append before sending data to the backend. Some valid choices include: "NONE", "PROXY\_V1" \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service dictionary / required \| \| A reference to the BackendService resource. This field represents a link to a BackendService resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_backend\_service task and then set this service field to "{{ name-of-resource }}" \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| ssl\_certificates list / elements=dictionary / required \| \| A list of SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified. \| \| ssl\_policy dictionary \| \| A reference to the SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. This field represents a link to a SslPolicy resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_ssl\_policy task and then set this ssl\_policy field to "{{ name-of-resource }}" \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/v1/targetSslProxies> * Setting Up SSL proxy for Google Cloud Load Balancing: <https://cloud.google.com/compute/docs/load-balancing/tcp-ssl/> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a instance group google.cloud.gcp_compute_instance_group: name: instancegroup-targetsslproxy zone: us-central1-a project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: instancegroup - name: create a health check google.cloud.gcp_compute_health_check: name: healthcheck-targetsslproxy type: TCP tcp_health_check: port_name: service-health request: ping response: pong healthy_threshold: 10 timeout_sec: 2 unhealthy_threshold: 5 project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: healthcheck - name: create a backend service google.cloud.gcp_compute_backend_service: name: backendservice-targetsslproxy backends: - group: "{{ instancegroup.selfLink }}" health_checks: - "{{ healthcheck.selfLink }}" protocol: SSL project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: backendservice - name: create a SSL certificate google.cloud.gcp_compute_ssl_certificate: name: sslcert-targetsslproxy description: A certificate for testing. Do not use this certificate in production certificate: \|- -----BEGIN CERTIFICATE----- MIICqjCCAk+gAwIBAgIJAIuJ+0352Kq4MAoGCCqGSM49BAMCMIGwMQswCQYDVQQG EwJVUzETMBEGA1UECAwKV2FzaGluZ3RvbjERMA8GA1UEBwwIS2lya2xhbmQxFTAT BgNVBAoMDEdvb2dsZSwgSW5jLjEeMBwGA1UECwwVR29vZ2xlIENsb3VkIFBsYXRm b3JtMR8wHQYDVQQDDBZ3d3cubXktc2VjdXJlLXNpdGUuY29tMSEwHwYJKoZIhvcN AQkBFhJuZWxzb25hQGdvb2dsZS5jb20wHhcNMTcwNjI4MDQ1NjI2WhcNMjcwNjI2 MDQ1NjI2WjCBsDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xETAP BgNVBAcMCEtpcmtsYW5kMRUwEwYDVQQKDAxHb29nbGUsIEluYy4xHjAcBgNVBAsM FUdvb2dsZSBDbG91ZCBQbGF0Zm9ybTEfMB0GA1UEAwwWd3d3Lm15LXNlY3VyZS1z aXRlLmNvbTEhMB8GCSqGSIb3DQEJARYSbmVsc29uYUBnb29nbGUuY29tMFkwEwYH KoZIzj0CAQYIKoZIzj0DAQcDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ 4mzkzTv0dXyB750fOGN02HtkpBOZzzvUARTR10JQoSe2/5PIwaNQME4wHQYDVR0O BBYEFKIQC3A2SDpxcdfn0YLKineDNq/BMB8GA1UdIwQYMBaAFKIQC3A2SDpxcdfn 0YLKineDNq/BMAwGA1UdEwQFMAMBAf8wCgYIKoZIzj0EAwIDSQAwRgIhALs4vy+O M3jcqgA4fSW/oKw6UJxp+M6a+nGMX+UJR3YgAiEAvvl39QRVAiv84hdoCuyON0lJ zqGNhIPGq2ULqXKK8BY= -----END CERTIFICATE----- private_key: \|- -----BEGIN EC PRIVATE KEY----- MHcCAQEEIObtRo8tkUqoMjeHhsOh2ouPpXCgBcP+EDxZCB/tws15oAoGCCqGSM49 AwEHoUQDQgAEHGzpcRJ4XzfBJCCPMQeXQpTXwlblimODQCuQ4mzkzTv0dXyB750f OGN02HtkpBOZzzvUARTR10JQoSe2/5PIwQ== -----END EC PRIVATE KEY----- project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: sslcert - name: create a target SSL proxy google.cloud.gcp_compute_target_ssl_proxy: name: test_object ssl_certificates: - "{{ sslcert }}" service: "{{ backendservice }}" project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. \| \| id integer \| success \| The unique identifier for the resource. \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| proxyHeader* string \| success \| Specifies the type of proxy header to append before sending data to the backend. \| \| service dictionary \| success \| A reference to the BackendService resource. \| \| sslCertificates list / elements=string \| success \| A list of SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified. \| \| sslPolicy dictionary \| success \| A reference to the SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs
ansible google.cloud.gcp_tpu_node – Creates a GCP Node google.cloud.gcp\_tpu\_node – Creates a GCP Node ================================================ Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_tpu_node`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * A Cloud TPU instance. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accelerator\_type string / required \| \| The type of hardware accelerators associated with this node. \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| cidr\_block string \| \| The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. \| \| description string \| \| The user-supplied description of the TPU. Maximum of 512 characters. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| labels dictionary \| \| Resource labels to represent user provided metadata. \| \| name string / required \| \| The immutable name of the TPU. \| \| network string \| \| The name of a network to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. \| \| project string \| \| The Google Cloud Platform project to use. \| \| scheduling\_config dictionary \| \| Sets the scheduling options for this TPU instance. \| \| \| preemptible boolean / required \| Choices:* no * yes \| Defines whether the TPU instance is preemptible. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| tensorflow\_version string / required \| \| The version of Tensorflow running in the Node. \| \| use\_service\_networking boolean \| Choices:* no * yes Default:"false" \| Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr\_block field should not be specified. If the network that you want to peer the TPU Node to is a Shared VPC network, the node must be created with this this field enabled. \| \| zone string \| \| The GCP location for the TPU. If it is not provided, the provider zone is used. \| Notes ----- Note * API Reference: <https://cloud.google.com/tpu/docs/reference/rest/v1/projects.locations.nodes> * Official Documentation: <https://cloud.google.com/tpu/docs/> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a node google.cloud.gcp_tpu_node: name: test_object zone: us-central1-b accelerator_type: v3-8 tensorflow_version: '1.11' cidr_block: 10.2.0.0/29 project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| acceleratorType string \| success \| The type of hardware accelerators associated with this node. \| \| cidrBlock string \| success \| The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. \| \| description string \| success \| The user-supplied description of the TPU. Maximum of 512 characters. \| \| labels dictionary \| success \| Resource labels to represent user provided metadata. \| \| name string \| success \| The immutable name of the TPU. \| \| network string \| success \| The name of a network to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, "default" will be used. \| \| networkEndpoints complex \| success \| The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node first reach out to the first (index 0) entry. \| \| \| ipAddress string \| success \| The IP address of this network endpoint. \| \| \| port integer \| success \| The port of this network endpoint. \| \| schedulingConfig complex \| success \| Sets the scheduling options for this TPU instance. \| \| \| preemptible boolean \| success \| Defines whether the TPU instance is preemptible. \| \| serviceAccount string \| success \| The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data. \| \| tensorflowVersion string \| success \| The version of Tensorflow running in the Node. \| \| useServiceNetworking boolean \| success \| Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr\_block field should not be specified. If the network that you want to peer the TPU Node to is a Shared VPC network, the node must be created with this this field enabled. \| \| zone string \| success \| The GCP location for the TPU. If it is not provided, the provider zone is used. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_target_instance – Creates a GCP TargetInstance google.cloud.gcp\_compute\_target\_instance – Creates a GCP TargetInstance ========================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_target_instance`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Represents a TargetInstance resource which defines an endpoint instance that terminates traffic of certain protocols. In particular, they are used in Protocol Forwarding, where forwarding rules can send packets to a non-NAT’ed target instance. Each target instance contains a single virtual machine instance that receives and handles traffic from the corresponding forwarding rules. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| description string \| \| An optional description of this resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| instance dictionary / required \| \| A URL to the virtual machine instance that handles traffic for this target instance. Accepts self-links or the partial paths with format `projects/project/zones/zone/instances/instance' or `zones/zone/instances/instance` . This field represents a link to a Instance resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp\_compute\_instance task and then set this instance field to "{{ name-of-resource }}" \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| nat\_policy* string \| Default:"NO\_NAT" \| NAT option controlling how IPs are NAT'ed to the instance. Currently only NO\_NAT (default value) is supported. Some valid choices include: "NO\_NAT" \| \| project string \| \| The Google Cloud Platform project to use. \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| \| zone string / required \| \| URL of the zone where the target instance resides. \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/v1/targetInstances> * Using Protocol Forwarding: <https://cloud.google.com/compute/docs/protocol-forwarding> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a network google.cloud.gcp_compute_network: name: network-instance project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: network - name: create a instance google.cloud.gcp_compute_instance: name: "{{ resource_name }}" machine_type: n1-standard-1 disks: - auto_delete: 'true' boot: 'true' initialize_params: source_image: projects/ubuntu-os-cloud/global/images/family/ubuntu-1604-lts labels: environment: production network_interfaces: - network: "{{ network }}" zone: us-central1-a project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" state: present register: instance - name: create a target instance google.cloud.gcp_compute_target_instance: name: target instance: "{{ instance }}" zone: us-central1-a project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| creationTimestamp string \| success \| Creation timestamp in RFC3339 text format. \| \| description string \| success \| An optional description of this resource. \| \| instance dictionary \| success \| A URL to the virtual machine instance that handles traffic for this target instance. Accepts self-links or the partial paths with format `projects/project/zones/zone/instances/instance' or `zones/zone/instances/instance` . \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| natPolicy* string \| success \| NAT option controlling how IPs are NAT'ed to the instance. Currently only NO\_NAT (default value) is supported. \| \| zone string \| success \| URL of the zone where the target instance resides. \| ### Authors * Google Inc. (@googlecloudplatform) ansible google.cloud.gcp_compute_external_vpn_gateway – Creates a GCP ExternalVpnGateway google.cloud.gcp\_compute\_external\_vpn\_gateway – Creates a GCP ExternalVpnGateway ==================================================================================== Note This plugin is part of the [google.cloud collection](https://galaxy.ansible.com/google/cloud) (version 1.0.2). 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 google.cloud`. To use it in a playbook, specify: `google.cloud.gcp_compute_external_vpn_gateway`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Represents a VPN gateway managed outside of GCP. Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 2.6 * requests >= 2.18.4 * google-auth >= 1.3.0 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auth\_kind string / required \| Choices:* application * machineaccount * serviceaccount \| The type of credential used. \| \| description string \| \| An optional description of this resource. \| \| env\_type string \| \| Specifies which Ansible environment you're running this module within. This should not be set unless you know what you're doing. This only alters the User Agent string for any API requests. \| \| interfaces list / elements=dictionary \| \| A list of interfaces on this external VPN gateway. \| \| \| id integer \| \| The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway \* `0 - SINGLE\_IP\_INTERNALLY\_REDUNDANT` \* `0, 1 - TWO\_IPS\_REDUNDANCY` \* `0, 1, 2, 3 - FOUR\_IPS\_REDUNDANCY` . \| \| \| ip\_address string \| \| IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. \| \| name string / required \| \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| project* string \| \| The Google Cloud Platform project to use. \| \| redundancy\_type string \| \| Indicates the redundancy type of this external VPN gateway . Some valid choices include: "FOUR\_IPS\_REDUNDANCY", "SINGLE\_IP\_INTERNALLY\_REDUNDANT", "TWO\_IPS\_REDUNDANCY" \| \| scopes list / elements=string \| \| Array of scopes to be used \| \| service\_account\_contents jsonarg \| \| The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. \| \| service\_account\_email string \| \| An optional service account email address if machineaccount is selected and the user does not wish to use the default email. \| \| service\_account\_file path \| \| The path of a Service Account JSON file if serviceaccount is selected as type. \| \| state string \| Choices:* present ← * absent \| Whether the given object should exist in GCP \| Notes ----- Note * API Reference: <https://cloud.google.com/compute/docs/reference/rest/beta/externalVpnGateways> * for authentication, you can set service\_account\_file using the `gcp_service_account_file` env variable. * for authentication, you can set service\_account\_contents using the `GCP_SERVICE_ACCOUNT_CONTENTS` env variable. * For authentication, you can set service\_account\_email using the `GCP_SERVICE_ACCOUNT_EMAIL` env variable. * For authentication, you can set auth\_kind using the `GCP_AUTH_KIND` env variable. * For authentication, you can set scopes using the `GCP_SCOPES` env variable. * Environment variables values will only be used if the playbook values are not set. * The service\_account\_email and service\_account\_file options are mutually exclusive. Examples -------- ``` - name: create a external vpn gateway google.cloud.gcp_compute_external_vpn_gateway: name: test_object redundancy_type: SINGLE_IP_INTERNALLY_REDUNDANT descrpition: An externalyl managed VPN gateway interfaces: - id: 0 ip_address: 8.8.8.8 project: test_project auth_kind: serviceaccount service_account_file: "/tmp/auth.pem" state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| description string \| success \| An optional description of this resource. \| \| interfaces complex \| success \| A list of interfaces on this external VPN gateway. \| \| \| id integer \| success \| The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway \* `0 - SINGLE\_IP\_INTERNALLY\_REDUNDANT` \* `0, 1 - TWO\_IPS\_REDUNDANCY` \* `0, 1, 2, 3 - FOUR\_IPS\_REDUNDANCY` . \| \| \| ipAddress string \| success \| IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. \| \| name string \| success \| Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]\[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. \| \| redundancyType* string \| success \| Indicates the redundancy type of this external VPN gateway . \| ### Authors * Google Inc. (@googlecloudplatform)	programming_docs

Subsets and Splits

No saved queries yet

Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.