azure_rm_rediscache – Manage Azure Cache for Redis instance

From Get docs
Ansible/docs/2.8/modules/azure rm rediscache module


azure_rm_rediscache – Manage Azure Cache for Redis instance

New in version 2.8.


Synopsis

  • Create, update and delete instance of Azure Cache for Redis.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults Comments

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in 2.6

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in 2.5

Default:

"latest"

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

append_tags

boolean

  • 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 2.5

  • auto
  • cli
  • credential_file
  • env
  • msi

Controls the source of the credentials to use for authentication.

If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.

auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.

When set to cli, the credentials will be sources from the default Azure CLI profile.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.

The msi was added in Ansible 2.6.

cert_validation_mode

string

added in 2.5

  • 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 2.4

Default:

"AzureCloud"

For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.

enable_non_ssl_port

boolean

  • no

  • yes

When true, the non-ssl redis server port 6379 will be enabled.

location

-

Resource location. If not set, location from the resource group will be used as default.

maxfragmentationmemory_reserved

-

Configures the amount of memory in MB that is reserved to accommodate for memory fragmentation.

maxmemory_policy

-

  • volatile_lru
  • allkeys_lru
  • volatile_random
  • allkeys_random
  • volatile_ttl
  • noeviction

Configures the eviction policy of the cache.

maxmemory_reserved

-

Configures the amount of memory in MB that is reserved for non-cache operations.

name

- / required

Unique name of the Azure Cache for Redis to create or update.

notify_keyspace_events

-

Allows clients to receive notifications when certain events occur.

password

-

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.

reboot

-

Reboot specified Redis node(s). There can be potential data loss.

reboot_type

-

  • primary
  • secondary
  • all

Which Redis node(s) to reboot.

shard_id

integer

If clustering is enabled, the id of the shard to be rebooted.

regenerate_key

-

Regenerate Redis cache's access keys.

key_type

-

  • primary
  • secondary

The Redis key to regenerate.

resource_group

- / required

Name of the resource group to which the resource belongs.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

shard_count

integer

The number of shards to be created when sku is premium.

sku

-

Sku info of Azure Cache for Redis.

name

- / required

  • basic
  • standard
  • premium

Type of Azure Cache for Redis to deploy

size

- / required

  • C0
  • C1
  • C2
  • C3
  • C4
  • C5
  • C6
  • P1
  • P2
  • P3
  • P4

Size of Azure Cache for Redis to deploy.

When sku is basic or standard, allowed values are C0, C1, C2, C3, C4, C5, C6.

When sku is premium, allowed values are P1, P2, P3, P4.

state

-

  • absent
  • present

Assert the state of the Azure Cache for Redis.

Use present to create or update an Azure Cache for Redis and absent to delete it.

static_ip

-

Static IP address. Required when deploying an Azure Cache for Redis inside an existing Azure virtual network.

subnet

-

Subnet in a virtual network to deploy the Azure Cache for Redis in.

It can be resource id of subnet, eg. /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1

It can be a dictionary where contains name, virtual_network_name and resource_group.

name. Name of the subnet.

resource_group. Resource group name of the subnet.

virtual_network_name. Name of virtual network to which this subnet belongs.

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.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

tenant_settings

-

Dict of tenant settings.

wait_for_provisioning

boolean

  • no
  • yes

Wait till the Azure Cache for Redis instance provisioning_state is Succeeded.

It takes several minutes for Azure Cache for Redis to be provisioned ready for use after creating/updating/rebooting.

Set this option to true to wait for provisioning_state. Set to false if you don't care about provisioning_state.

Poll wait timeout is 60 minutes.



Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
  • Authentication is also possible using a service principal or Active Directory user.
  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.


See Also

See also

Sign in with Azure CLI
How to authenticate using the az login command.


Examples

- name: Create an Azure Cache for Redis
  azure_rm_rediscache:
      resource_group: myResourceGroup
      name: myRedis
      sku:
        name: basic
        size: C1

- name: Scale up the Azure Cache for Redis
  azure_rm_rediscache:
      resource_group: myResourceGroup
      name: myRedis
      sku:
        name: standard
        size: C1
      tags:
        testing: foo

- name: Force reboot the redis cache
  azure_rm_rediscache:
      resource_group: myResourceGroup
      name: myRedisCache
      reboot:
        reboot_type: all

- name: Create Azure Cache for Redis with subnet
  azure_rm_rediscache:
      resource_group: myResourceGroup
      name: myRedis
      sku:
        name: premium
        size: P1
      subnet: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirt
               ualNetwork/subnets/mySubnet"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

host_name

string

state is present

Host name of the Azure Cache for Redis.


Sample:

{'host_name': 'myredis.redis.cache.windows.net'}

id

string

always

Id of the Azure Cache for Redis.


Sample:

{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis'}




Status

Authors

  • Yunge Zhu(@yungezz)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_rediscache_module.html