hpe.nimble.hpe_nimble_protection_template – Manage the HPE Nimble Storage protection templates

Note

This plugin is part of the hpe.nimble collection (version 1.1.3).

To install it use: ansible-galaxy collection install hpe.nimble.

To use it in a playbook, specify: hpe.nimble.hpe_nimble_protection_template.

New in version 1.0.0: of hpe.nimble

Synopsis

  • Manage the protection templates on an HPE Nimble Storage group.

Requirements

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

  • Ansible 2.9 or later

  • Python 3.6 or later

  • HPE Nimble Storage SDK for Python

  • HPE Nimble Storage arrays running NimbleOS 5.0 or later

Parameters

Parameter Choices/Defaults Comments
agent_hostname
string
Generic backup agent hostname.
agent_password
string
Generic backup agent password.
agent_username
string
Generic backup agent username.
app_cluster
string
If the application is running within a windows cluster environment, this is the cluster name.
app_id
string
    Choices:
  • inval
  • exchange
  • exchange_dag
  • hyperv
  • sql2005
  • sql2008
  • sql2012
  • sql2014
  • sql2016
  • sql2017
Application ID running on the server.
app_server
string
Application server hostname.
app_service_name
string
If the application is running within a windows cluster environment then this is the instance name of the service running within the cluster environment.
app_sync
string
    Choices:
  • none
  • vss
  • vmware
  • generic
Application synchronization.
change_name
string
Change name of the existing protection template.
description
string
Text description of protection template.
host
string / required
HPE Nimble Storage IP address.
name
string / required
Name of the protection template.
password
string / required
HPE Nimble Storage password.
state
string / required
    Choices:
  • present
  • absent
  • create
The protection template operations.
username
string / required
HPE Nimble Storage user name.
vcenter_hostname
string
VMware vCenter hostname.
vcenter_password
string
Application VMware vCenter password. A password with few constraints.
vcenter_username
string
Application VMware vCenter username. String of up to 80 alphanumeric characters, beginning with a letter. It can include ampersand (@), backslash (\), dash (-), period (.), and underscore (_).

Notes

Note

  • This module does not support check_mode.

Examples

# if state is create , then create a protection template if not present. Fails if already present.
# if state is present, then create a protection template if not present. Succeed if it already exists.
- name: Create protection template if not present
  hpe.nimble.hpe_nimble_protection_template:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    description: "{{ description | default(None)}}"
    state: "{{ state | default('present') }}"

- name: Delete protection template
  hpe.nimble.hpe_nimble_protection_template:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: absent

Authors