Deprecation notice

This software is no longer maintained. Use https://github.com/hpe-storage/nimble-ansible-modules as a substitute.

NimbleStorage.Ansinimble

Manages software and products from Nimble Storage. This is BETA software.

Requirements

Ansinimble supports two different product lines. HPE Nimble Storage arrays and HPE Cloud Volumes. Requirements vary slightly between products.

Nimble Arrays

This role assumes the latest Nimble Linux Toolkit (NLT) is installed on the host being managed by Ansible. The latest version of NLT may be obtained from InfoSight (Nimble customers and partners only).

Requires an HPE Nimble Storage array with NimbleOS 3.3+
Requires Ansible 2.3.3+ with the jmespath Python package installed (please see deprecation notes on Ansible 2.5 below)
Requires the sshpass package to be installed on the Ansible host if using the group cli task
Requires the Python netaddr package if using the array setup task

Cloud Volumes

Host requirements are less stringent for Cloud Volumes. The Linux Connection Manager found on the Cloud Volumes portal needs to be installed but there is a task that can do that for you.

Requires API access to HPE Cloud Volumes
Requires Ansible 2.3.3+ with the jmespath and boto (for EC2 and HPE Cloud Volumes) Python package installed on the Ansible host. (please see deprectation notes on Ansible 2.5 below)

Deprecation notes and tested versions of Ansible

The following versions of Ansible are currently being tested for compatability with Ansinimble:

2.3.3.0
2.4.6.0
2.5.15
2.6.16
2.7.10
2.8.3

Deprecated Ansible versions Ansinimble no longer support:

2.2.3.0

When Ansible 2.9 becomes generally available, the role will be re-written and only support Ansible 2.5+. A number of deprecation warnings will be present when executing with Ansible 2.4 and above, they are harmless. Deprecation warnings may safely be disabled.

Breaking changes between releases

Ansinimble is beta software and might introduce breaking changes between versions:

Beyond 0.14.0 Issue #27 breaks stacking of roles as the Ansible Host is now responsible for all REST API interaction with the array. That means that the array need to be a line item in the inventory using ansible_connection=local. For example, creating a volume would be a role you'd assign to the array. All examples have been updated to reflect this behaviour.

Note: Non-breaking additional features are documented with the release on GitHub.

Important: When executing with Ansible 2.5+, ansible-playbook -b (become) must be used for the role to work properly. This is due to a change in the include statement.

Documentation

Getting started with the Ansinimble role can be intimidating. Keep an eye out on datamattson.io with the Ansinimble tag.

Tutorials available so far:

There's also plenty of examples further down and in the examples directory.

Reference documentation

Role Variables

The importance of variables depends on what objects are being managed.

These are the offical defaults that are accompanied for each task or used as an example data structure. Some variables makes sense per host, per ansible host or grouped. Explore each task to learn more.

---
# These are required.
nimble_group_options:
  ip-address: 192.168.59.64
  username: admin

# Please store password with Ansible Vault
nimble_group_password: admin

# Default Nimble folder options
nimble_folder_options_default:
  description: "Folder created by Ansible"

nimble_folder_update_options_default:
  description: "Folder updated by Ansible"

# Default volcoll options (when created standalone)
nimble_volcoll_options_default:
  description: "Volume Collection created by Ansible"
nimble_volcoll_snapshot_options_default: {}

# Default protection template options
nimble_prottmpl_options_default:
  description: "Protection Template created by Ansible"

nimble_protsched_options_default:
  description: "Protection Schedule created by Ansible"
  volcoll_or_prottmpl_type: protection_template

# Default partnership options as fallbacks
nimble_partnership_options_default:
  upstream:
    description: "Established by Ansible"
    subnet_label: mgmt-data
  downstream:
    description: "Established by Ansible"
    subnet_label: mgmt-data
    name: upstream
    hostname: "{{ nimble_group_options['ip-address'] }}"
    username: "{{ nimble_group_options.username }}"
    password: "{{ nimble_group_password }}"

# Default cloud partnership options
nimble_cloud_partnership_options_default:
  description: "Established by Ansible"
  subnet_label: mgmt-data
  partner_type: tunnel_endpoint

# Example partnership stanza
nimble_partnerships:
  test:
    secret: "Secret-00"
    upstream:
      description: "Established by Ansible"
      subnet_label: mgmt-data
      name: "group-downstream-array"
      hostname: "downstream-array.example.com"
      username: "admin"
      password: "password"
    downstream:
      description: "Established by Ansible"
      subnet_label: mgmt-data
      name:  "group-upstream-array"
      hostname: "upstream-array.example.com"
      username: "admin"
      password: "password"

# These are the group facts gathered if no filters are applied with nimble_group_facts
nimble_group_facts_default:
  access_control_records:
  arrays:
  folders:
  initiator_groups:
  initiators:
  performance_policies:
  pools:
  subnets:
  volumes:
  volume_collections:
  protection_templates:

# How to reach the Nimble group
nimble_group_http_scheme: https
nimble_group_http_port: 5392
nimble_group_api_version: v1
nimble_group_url: "{{ nimble_group_http_scheme }}://{{ nimble_group_options['ip-address'] }}:{{ nimble_group_http_port }}/{{ nimble_group_api_version }}"

# This is an optimistic guess, please provide discovery IP in complex setups
nimble_group_discovery_ip: "{{ nimble_group_facts | json_query('subnets[?allow_iscsi==`true`].discovery_ip | [0]') }}"

# Set to true to perform static nimble_host_facts from inventory
nimble_static_host_facts: False

# Host locations
nimble_host_docker_conf_file: /opt/NimbleStorage/etc/docker-driver.conf
nimble_host_docker_driver_name: Docker-Driver
nimble_host_iqn_file: /etc/iscsi/initiatorname.iscsi
nimble_host_device_prefix: /dev/nimblestorage
nimble_linux_toolkit_prefix: /opt/NimbleStorage
nimble_linux_toolkit_options_default:
  - "silent-mode"
  - "accept-eula"
  - "ncm"
nimble_host_protocol: iscsi

# Set to True to disable any NLT interaction
nimble_linux_toolkit_ignore: False

# Set to False to enable connecting NLT to array
# Not honored if nimble_linux_toolkit_ignore is True
nimble_linux_toolkit_nogroup: True

# Default initiator options
nimble_initiator_group_options_default:
  description: "Created by Ansible"

nimble_initiator_options_default:
  access_protocol: "{{ nimble_host_protocol }}"
  iqn: "{{ nimble_host_facts.iqn }}"
  ip_address: "*"

# Default volume options
nimble_volume_mount_options: "_netdev,auto,nouuid"
nimble_volume_mkfs_options: ""
nimble_volume_size: 1000
nimble_volume_options_default:
  description: "Volume created by Ansible"
nimble_volume_update_options_default: {}
nimble_snapshot_update_options_default: {}

# Default performance policy options
nimble_perfpolicy_blocksize: 4096
nimble_perfpolicy_options_default:
  description: "Performance Policy created by Ansible"
  app_category: "Other"
nimble_perfpolicy_update_options_default:
  description: "Performance Policy updated by Ansible"

# Device retries
nimble_device_retries: 5
nimble_device_delay: 24

# NimbleOS HTTP/JSON tunables
nimble_uri_retries: 6
nimble_uri_delay: 10
nimble_silence_payload: True

# NimbleOS setup from scratch example
nimble_array_config:
  XX-000000:                                 # This is the serial number of the new array
    group_name: group-sjc-tme000-va          # Name of the group.
    name: sjc-tme000-va                      # Name of the array.
    domainname: vlab.nimblestorage.com       # DNS domain name of this system.
    ntpserver: time.nimblestorage.com        # Hostname or IP address of NTP server.
    timezone: America/Los_Angeles            # Time zone that the array is in.
    mgmt_ipaddr: 10.18.173.174               # Management IP address.
    default_gateway: 10.18.160.1             # Default gateway IP address.

    dnsservers:                              # IP addresses of the DNS servers.
      - 10.18.5.4
      - 10.12.255.254

    iscsi_automatic_connection_method: "yes" # Redirect connections from the specified
                                             # iSCSI target IP appropriately.

    iscsi_connection_rebalancing: "yes"      # Rebalance iSCSI connections by periodically
                                             # breaking existing connections that are
                                             # out-of-balance.

    subnets:                                 # Subnets to configure (In NIC order)
      - label: mgmt-data                     # Subnet Label on NIC.
        subnet_addr: 10.18.173.174/19        # Subnet on NIC.
        subnet_type: management              # Type of subnet -- data, management, or data
                                             # and management
        subnet_mtu: 1500                     # Size of MTU - standard, jumbo, other.

      - label: mgmt-data                     # Subnet Label on NIC.
        subnet_addr: 10.18.173.174/19        # Subnet on NIC.
        subnet_type: management              # Type of subnet -- data, management, or data
                                             # and management
        subnet_mtu: 1500                     # Size of MTU - standard, jumbo, other.

      - label: data1                         # Subnet Label on NIC.
        data_ipaddr: 172.16.237.135          # Data IP address setting.
        subnet_addr: 172.16.237.135/19       # Subnet on NIC.
        subnet_type: data                    # Type of subnet -- data, management, or data
                                             # and management
        subnet_mtu: 1500                     # Size of MTU - standard, jumbo, other.

      - label: data2                         # Subnet Label on NIC.
        data_ipaddr: 172.16.45.159           # Data IP address setting.
        subnet_addr: 172.16.45.159/19        # Subnet on NIC.
        subnet_type: data                    # Type of subnet -- data, management, or data
                                             # and management
        subnet_mtu: 1500                     # Size of MTU - standard, jumbo, other.

    discovery_ipaddrs:                       # Discovery IP address setting.
      - 172.16.237.136
      - 172.16.45.160

    support_ipaddrs:
      - 10.18.173.175                        # Support IP address setting node A.
      - 10.18.173.176                        # Support IP address setting node B.

# Set to 'False' when using multiple initiators dynamically mapping/unmapping the volume
nimble_volume_unmap_volume_connections: True

# Cloud Volumes
cloud_portal_http_host: cloudvolumes.hpe.com

# Please protect your credentials with Ansible Vault
cloud_portal_access_key: nimble
cloud_portal_secret_key: nimblestorage

cloud_lcm_installer: https://cloudvolumes.hpe.com/tools/ncv_installer_latest
cloud_lcm_prefix: /opt/NimbleStorage
cloud_host_iqn_file: /etc/iscsi/initiatorname.iscsi

# Cloud Portal
cloud_portal_http_scheme: https
cloud_portal_http_port: 443
cloud_portal_api_version: v2
cloud_portal_url: "{{ cloud_portal_http_scheme }}://{{ cloud_portal_http_host }}:{{ cloud_portal_http_port }}"
cloud_portal_api_endpoint: "{{ cloud_portal_url }}/api/{{ cloud_portal_api_version }}"

# HTTP/JSON tunables
cloud_uri_retries: 24 
cloud_uri_delay: 10
cloud_silence_payload: True

# Default Cloud Portal facts
cloud_portal_facts_default:
  cloud_volumes:
  regions:
  session:
  initiators:
  interfaces:
  onprem_replication_partners:
  replication_partnerships:
  replication_stores:
  providers:

# Default Cloud Volume options
cloud_volume_mount_options: "_netdev,auto"
cloud_volume_mkfs_options: ""
cloud_volume_size: 10000
cloud_volume_from_default: {}
cloud_volume_resize_body: {}

cloud_volume_options_default:
  volume_type: PF
  encryption: False
  schedule: none
  retention: 0
  perf_policy: "Windows File Server"
  iops: 1000

cloud_volume_mandatory_options:
  - existing_cloud_subnet
  - private_cloud 

cloud_replica_options_default:
  iops: 1000

cloud_replica_mandatory_options:
  - existing_cloud_subnet
  - private_cloud 

cloud_replica_snapshot_index: 0

# Default Replication Store options
cloud_store_options_default:
  volume_type: GPF
cloud_store_size: 1099776
cloud_store_size_min: 1099776
cloud_store_size_max: 32985088
cloud_store_region: us-test

# Cloud host defaults
cloud_host_device_prefix: /dev/nimblestorage
cloud_device_retries: 3
cloud_device_delay: 10

Usage

Managing Nimble Storage arrays and Cloud Volumes vary slightly as consuming storage as a service vs infrastructure are two separate domains. The most significant difference is that the object and operation is prefixed either nimble or cloud. The role should be able to manage both if you have hosts connected to both on premises Nimble Storage arrays and Cloud Volumes.

Nimble Storage Array Operations

Each nimble_object and nimble_operation combo has a set of parameters that control what resources are being managed.

nimble_object nimble_operation

Example usage of folder create:

- hosts: myhost
  vars: 
    nimble_folder: myfolder
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: folder, 
        nimble_operation: create 
      }

folder create

Creates a Nimble folder.

nimble_folder: Folder name
nimble_folder_options: Dictionary of folder options

folder update

Updates a Nimble folder.

nimble_folder: Folder name
nimble_folder_options: Dictionary of folder options to update

folder delete

Deletes a Nimble folder.

nimble_folder: Folder name

volume create

Create a new volume or clone from a snapshot.

nimble_volume: An ASCII string (some special characters allowed)
nimble_volume_size: Optional size in MiB, defaults to 10GiB
nimble_volume_from: Create volume from this source volume (name) 
nimble_volume_snapshot: Use this source snapshot to clone from (uses last snapshot if not specified)
nimble_volume_options: A dictionary of Nimble volume options (please see the REST documentation)

Note that the parameters perfpolicy_id, pool_id and folder_id accepts the vanity name as key in nimble_volume_options.

volume update

Updates a mutable attribute on a volume.

nimble_volume: Nimble volume name
nimble_volume_update_options: Key/value list of options to update. See the example section and the REST API documentation available on HPE InfoSight.

volume map

Maps a volume to a host on the group.

nimble_volume: Volume to map
nimble_host_name: Host to map to the volume
nimble_initiator_group_options: Options to apply to the initiator group (uses the node's IQN by default, hence this option is opional)

volume attach

Attach a volume to a host

nimble_volume: Volume to attach

volume mount

Mounts a volume on the host, creates a new filesystem if there is no filesystem on the volume.

nimble_volume: Nimble volume to mount
nimble_volume_mountpoint: Where to mount it
nimble_volume_mount_options: Mount options to put in /etc/fstab (optional)
nimble_volume_mkfs_options: Flags to pass to mkfs.xfs (optional)

volume resize

Resizes (expands) a volume and filesystem.

nimble_volume: Volume name to resize
nimble_volume_size: Size in MiB to set volume to (currently no sanity checks)
nimble_volume_mountpoint: Where the volume is currently mounted

volume snapshot

Snapshots a Nimble volume.

nimble_volume: Volume to snapshot
nimble_volume_snapshot: Snapshot name (optional, uses timestamp)

snapshot update

Updates mutable attributes on a snapshot.

nimble_volume: Volume snapshot exist on
nimble_volume_snapshot: Snapshot to update
nimble_snapshot_update_options: Key/value pair of options to update. See the examples and the REST API what fields are mutable.

volume umount

Unmounts a filesystem on the host and disconnects the volume.

nimble_volume: Volume to disconnect
nimble_volume_mountpoint: Filesystem to umount

volume unmap

Unmaps and offlines a volume on the Nimble group from an initiator.

nimble_volume: Volume to unmap and offline

volume detach

Detaches a volume from a host, will fail if filesystems are still mounted

nimble_volume: Volume to detach

volume restore

Restore a Nimble volume from a snapshot. Requires volume to be umounted and unmapped.

nimble_volume: Volume to restore
nimble_volume_snapshot: Snapshot name to restore to (optional, uses last snapshot if not specified)

volume delete

Permanently deletes a volume. Please umount and unmap first.

nimble_volume: Volume name to delete

volume protect

Protects a volume in either a dedicated volume collection with a protection template or an existing volume collection.

nimble_volume: Volume name to protect
nimble_protection_template: Name of protection template to create a new volume collection with
nimble_volcoll: Existing volume collection to add the volume to

Note: nimble_protection_template and nimble_volcoll are mutually exclusive.

volume unprotect

Remove the volume collection association from a volume.

nimble_volume: Volume name to remove volume collection association from

volcoll create

Create a new volume collection from a protection template.

nimble_volcoll: Name of the volume collection
nimble_volcoll_options: Key/value of volcoll options (see API documentation on HPE InfoSight)

volcoll prune

Prunes the array group of orphaned volume collections. No parameters needed.

volcoll snapshot

Snapshots a volume collection;

nimble_volcoll: Volume collection name
nimble_volcoll_snapshot: Optional volume collection snapshot name (uses a timestamp by default)
nimble_volcoll_snapshot_options: Optional key/value pair of attributes to apply to the volume collection (see API documentation on HPE InfoSight for valid fields)

prottmpl create

Creates a protection schedule with a set of schedules and replica destinations.

nimble_protection_template: Name of the protection template
nimble_protection_template_options: Key/value pairs of protection template options (see API documentation on HPE InfoSight)
nimble_protection_schedules:
  myschedule:
    downstream_partner_id: Name of downstream partner (optional)
    num_retain_replica: Number of snapshots to retain on the replica (optional)
    description: A human readable description of schedule (optional)
    period_unit: A human readable unit of periods such as "minutes", "hours", "days" or "weeks"
    days: A human readable comma separated list of days to take snapshots, example: "saturday,sunday"
    at_time: Non-negative integer in range [0,86399] which is equivalent to [0:00:00 AM, 23:59:59 PM]
    until_time: Time of day to stop taking snapshots (same range as above). Only applicable for units < "days".
    num_retain: Number of snapshots to retain in this schedule
  myotherschedule:
    ...

Note: More options are availble, please see the full API documentation on HPE InfoSight.

prottmpl delete

Deletes a protection template.

nimble_protection_template: Name of protection template to delete

replication partner

Partner with a downstream array group.

nimble_partner: Name of partnership to marry, example: mypartnership
nimble_partnerships:
  mypartnership:
    upstream:
      name: Vanity name of upstream group, example: group-sjc-array869
      hostname: FQDN of upstream array
      subnet_label: Label of network to use for replication
      description: "My upstream array"
    downstream:
      name: Vanity name of downstream group, example: group-sjc-array875
      hostname: FQDN of downstream array
      subnet_label: Label of network to use for replication
      username: Username on downstream array
      password: Password on downstream array
      description: "My downstream array"
    secret: Secret to use for pairing (minimum 8 chars)

replication divorce

Divorce an array group (may not be referenced by any protection templates)

nimble_partner: Replication partner name to delete

Note: Does not use nimble_partnerships data structure or communicates to both ends of the partnership

cloud partner

Partner an array group with Cloud Volumes.

cloud_store: Name of "Replication Store" in cloud volumes to use (will be created with default options if it doesn't exist)
cloud_store_region: Cloud Volumes region to use

Note: Require Cloud Volumes authentication variables to be set too

cloud divorce

Divorces a partnership with Cloud Volumes (may not have any protection templates associated).

cloud_store: Name of cloud store to divorce from

host facts

Gathers facts about the host in nimble_host_facts.

Example:

ok: [smokey] => {
    "nimble_host_facts": {
        "iqn": "iqn.1994-05.com.redhat:44be4d73789",
        "wwpns": []
    }
}

Note: Requires NLT to be running, will attempt to start or install it if not.

group facts

Gathers facts about the Nimble group suitable to perform json_query on.

Example playbook:

---
- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble, nimble_object: group, nimble_operation: facts, nimble_group_facts: { pools: 'fields=all_flash'} }
  tasks:
    - debug: var=nimble_group_facts

Example output:

ok: [smokey] => {
    "nimble_group_facts": {
        "pools": [
            {
                "all_flash": false
            }
        ]
    }
}

Note: Calling group facts with nimble_group_facts multiple times in the same play will have undesired effects. If a certain fact(s) need to be refreshed mid-play, use nimble_group_fact_refresh with the keys needed to be refreshed.

Please see variables section for more info.

Note: By default nimble_group_facts gobbles the entire group. At scale this could become an issue. Always try to be smart about what you need from the group and only query for data that is needed for processing.

group update

Updates configuration of a group. This task accepts an endless list of configuration options. Please the REST API documentation available on HPE InfoSight for the particular version of NimbleOS. Used to enfore configuration and prevent drift.

nimble_group_update: Advanced data structure to apply group configration. See the examples section.

Note: Configuration is applied for each update regardless of current value of the specific option. This might be addressed in a future update.

group cli

Uses the Ansible raw module to execute NimbleOS commands on the group.

nimble_group_cli: String to execute on the group. If passed on ansible-playbook -e argument, encapsulate in JSON format, see examples section.
nimble_group_cli_ignore_errors: Set to True to ignore errors

nlt manage

Manages NLT on a host.

nimble_linux_toolkit_state: Desired state, absent, present, running or stopped
nimble_linux_toolkit_bundle: Full path on control node to NLT installer (only required when present or running when not installed)
nimble_linux_toolkit_options: Additional installer flags (I.e docker or oracle). In list format.
nimble_host_protocol: fc or iscsi, optimizes the install procedure for either protocol. Defaults to iscsi.
nimble_linux_toolkit_nogroup: Do not configure NLT with nltadm --group --add, only relevant when used with legacy Docker or Oracle App Manager. Defaults is True.
nimble_linux_toolkit_ignore: Defaults to False. Will not under any circumstance try to install NLT. Some tasks won't work but is primarily used for provisioning resources to hosts with manual discovery.
nimble_static_host_facts: Used with the above parameter to manually populate host facts. See next paragraph.

If provisioning and mapping resources to a host without using Ansible to discover IQN or WWNPs, the following data structure is needed on the host:

nimble_host_facts:
  iqn: iqn.1993-08.org.debian:01:1d2529afe63e
  wwpns: []

Note: World Wide Port Names can be found in /sys/class/fc_host/host*/port_name for FC and search for initiatorname.iscsi in /etc to find a host IQN when using iSCSI.

array setup

Sets up an array from scratch. The Ansible host needs to be configured with ZeroConf in the same network as the arrays that needs to be setup.

nimble_array_serial: The serial number to setup, i.e AF-123456
nimble_array_discovery_interface: Interface on the Ansible host that is connected to the ZeroConf network, defaults to the network interface with a default gateway
nimble_array_config: Advanced YAML structure listing arrays to setup by serial number. Please see defaults/main.yml for an example

password update

Sets a new password for a user

nimble_password_user: Defaults to what's stored in nimble_group_options.username
nimble_password_new: New password, i.e Password-364

Note: The current password is stored in nimble_group_password Note #2: It's good practice to store passwords with Ansible Vault

perfpolicy create

Creates a new Performance Policy. Supports numerous options, see the API documentation on HPE InfoSight for valid keys in nimble_perfpolicy_options.

nimble_perfpolicy: A Performance Policy name
nimble_perfpolicy_blocksize: Defaults to 4096
nimble_perfpolicy_options:
  key: value

perfpolicy update

Updates a Performance Policy. Most fields except block size may be altered post creation, see the API documentation on HPE InfoSight for valid keys in nimble_perfpolicy_update_options

nimble_perfpolicy: Performance Policy name to update
nimble_perfpolicy_update_options:
  key: value

perfpolicy delete

Deletes a Performance Policy.

nimble_perfpolicy: Performance Policy name to delete

Cloud Volume Operations

Each cloud_object and cloud_operation combo has a set of parameters that control what resources are being managed.

cloud_object cloud_operation

Example usage of managing LCM (Linux Connection Manager)

- hosts: myhost
  roles:
    - { role: NimbleStorage.Ansinimble, cloud_object: lcm, cloud_operation: manage, cloud_lcm_state: present }

volume create

Creates or clones a Cloud Volume. This operation assumes a couple of default cloud_volume_options from the defaults definition. Please see the Cloud Volumes API documentation for full list of options.

cloud_volume: Cloud Volume to create
cloud_volume_from: Create Cloud Volume from this source volume (name) 
cloud_volume_snapshot: Use this source snapshot to clone from (uses last snapshot if not specified)
cloud_volume_provider: Amazon AWS or Microsoft Azure
cloud_volume_region: Which region to expose your volume, i.e us-west-1
cloud_volume_options: Below are the mandatory keys
  private_cloud: VPC or VNET
  existing_cloud_subnet: Subnet CIDR notation

volume update

Updates a Cloud Volume, such as changing the IOPS limit.

cloud_volume: Cloud Volume to update
cloud_volume_options: Key and value to update. Full list of options available in the Cloud Volumes API documentation.
  key: value

volume map

Maps a Cloud Volume to a cloud instance. (Does not login to the target)

cloud_volume: Cloud Volume to map
cloud_host_ip: IP address of your cloud instance

volume mount

Mounts a Cloud Volume on a cloud instance. Will create a new filesystem (XFS) and add an entry to fstab.

cloud_volume: Cloud Volume to mount (needs to be mapped prior)
cloud_volume_mountpoint: Where to mount the filesystem

volume resize

Resizes a Cloud Volume and resizes the filesystem. Needs to be mounted to succeed.

cloud_volume: Cloud Volume to resize
cloud_volume_mountpoint: Where the Cloud Volume is mounted 
cloud_volume_size: Size in total MB to set the volume to (only expansion)

volume snapshot

Snapshots a Cloud Volume

cloud_volume: Cloud Volume to snapshot
cloud_volume_snapshot: Optional snapshot name (uses a timestamp by default)

volume umount

Unmounts a Cloud Volume from a cloud instance and disconnects the volume from the host and wipes the fstab entry.

cloud_volume: Cloud Volume to unmount
cloud_volume_mountpoint: Where the Cloud Volume will be umounted from

volume unmap

Unmaps a Cloud Volume from a cloud instance.

cloud_volume: Cloud Volume to unmap
cloud_host_ip: The cloud instance IP address to unmap

volume restore

Restores a Cloud Volume from a known snapshot or last snapshot. The cloud volume needs to be unmounted and unmapped from the host prior.

cloud_volume: Cloud Volume to restore
cloud_volume_snapshot: Optional snapshot name, will default to last snapshot on the volume if not specified

volume delete

Deletes a Cloud Volume. Needs to be unmounted and unmapped from the host prior.

cloud_volume: Cloud Volume to delete

store create

Creates a Cloud Volume Replication Store.

cloud_store: Replication Store name
cloud_store_size: Size in MB between 1099776 and 32985088 (defaults to 1099776, ~1TB)
cloud_store_region: Which region to replicate to

store resize

Resizes a Cloud Volume Replication Store.

cloud_store: Replication Store name
cloud_store_size: New size between 1099776 and 32985088

store delete

Delete a Cloud Volume Replication Store.

cloud_store: Replication Store name to delete

replica clone

Creates a new Cloud Volume from a replicated volume inside a Replication Store.

cloud_volume: New Cloud Volume name
cloud_replica: Replica Store volume to clone from
cloud_replica_provider: Amazon AWS or Microsoft Azure
cloud_replica_region: Which region to expose your volume, i.e us-west-1
cloud_replica_options: Below are the mandatory keys
  private_cloud: VPC or VNET
  existing_cloud_subnet: Subnet CIDR notation

portal facts

Scrapes the facts off the Cloud Volume Portal for use with json_query filters. Primarily an internal task. Returns a JSON structure in cloud_portal_facts

cloud_portal_facts:
  key: Optional query filter, such as "fields=id,name" and where key is a Cloud Volume API URI such as cloud_volumes

lcm manage

Manages the Linux Connection Manager required to connect Cloud Volumes to a host.

cloud_lcm_state: absent or present
cloud_lcm_installer: Optional URL to installer, will grab whatever is set in default currently otherwise

host facts

Gathers host facts. Not currently used.

Example Playbooks

Here are some example uses of this role. These are cut and paste from examples

Nimble Storage Array Group Examples

Make sure credentials for NLT and the arrays are accessible in the appropriate variables.

sample_install.yml

Installs NLT.

---
# Provide nimble_linux_toolkit_bundle and nimble_host_protocol
# as extra vars to ansible-playbook, i.e:
# $ ansible-playbook -e nimble_linux_toolkit_bundle=/tmp/nlt_installer-2.0-0 \
# -e nimble_host_protocol=fc \
# sample_install.yml

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: nlt,
        nimble_operation: manage,
        nimble_linux_toolkit_state: running
      }

sample_uninstall.yml

Uninstalls NLT.

# Removes NLT from a host
# ansible-playbook sample_uninstall.yml
---
- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: nlt,
        nimble_operation: manage,
        nimble_linux_toolkit_state: absent
      }

sample_debug.yml

Croaks out all host and group facts

---
# Fetches all facts from an array into nimble_group_facts

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: group,
        nimble_operation: facts 
      }
  tasks:
    - debug: 
        var: nimble_group_facts

sample_group_fact.yml

Lightweight debugging.

---
# Fetches all volume facts from an array

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: group, 
        nimble_operation: facts,
        nimble_group_facts: { 
          volumes: 'fields=name,serial_number' 
        }
      }
  tasks:
    - debug: 
        var: nimble_group_facts

sample_group_update.yml

---
# Updates the group options. The following example updates the DNS domain, DNS servers and sets 
# a custom login banner message.
# $ ansible-playbook sample_group_update.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: group,
        nimble_operation: update,
        nimble_group_update: {
          domain_name: example.com,
          dns_servers: [
            { "ip_addr": "8.8.8.8" },
            { "ip_addr": "1.1.1.1" }
          ],
          login_banner_message:
            "This array is managed by Ansible. Configuration changes 
            may be overridden periodically. Contact support@example.com
            for further information."
        }
      }

Please see the REST API guide on HPE InfoSight on the specific NimbleOS version what options are supported in nimble_group_update.

sample_group_cli.yml

---
# Execute a NimbleOS CLI command, stores return from the raw module in nimble_group_raw_return
# $ ansible-playbook -e '{"nimble_group_cli": "group --list"}' \
# sample_group_cli.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: group,
        nimble_operation: cli
      }
  tasks:
    - debug:
        var: nimble_group_cli_return.stdout_lines

Note: The raw module requires sshpass to be installed on the Ansible host.

sample_provision.yml

Provisions and mounts a new volume.

---
# Provide nimble_volume and nimble_volume_mountpoint as extra vars, i.e:
# $ ansible-playbook -e nimble_volume=myvol1 \
#   -e nimble_volume_mountpoint=/mnt/myvol1 \
#   -e nimble_host_name=myhost1
#   sample_provision.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: create 
      }
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: map 
      }

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: attach
      }
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: mount 
      }

sample_volume_update.yml

---
# Updates a mutable volume attribue. The following example updates the IOPS limit and description.
# $ ansible-playbook -e nimble_volume=myvol1 sample_volume_update.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: update ,
        nimble_volume_update_options: {
          limit_iops: 2000,
          description: Volume throttled by Ansible
        }
      }

sample_snapshot.yml

---
# Provide nimble_volume and nimble_volume_snapshot as extra vars, i.e:
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_volume_snapshot=mysnap1 \
# sample_snapshot.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: snapshot 
      }

sample_snapshot_update.yml

---
# Updates a mutable snapshot attribue. The following example renames a snapshot on a volume.
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_volume_snapshot=myoldsnapname \
# -e '{"nimble_snapshot_update_options": {"name": "mynewsnapname"}}' \
# sample_snapshot_update.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: snapshot,
        nimble_operation: update
      }

sample_restore.yml

---
# Provide nimble_volume, nimble_volume_mountpoint and nimble_volume_snapshot as extra vars, i.e
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_volume_mountpoint=/mnt/myvol1 \
# -e nimble_volume_snapshot=mysnap1 \
# -e nimble_host_name=myhost1
# sample_restore.yml

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: umount 
      }
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: detach
      }

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: unmap
      }
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: restore 
      }
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: map 
      }

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: attach
      }
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: mount
      }

sample_resize.yml

---
# Provide nimble_volume and nimble_volume_size as extra vars, i.e:
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_volume_size=2000 
# sample_resize.yml

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: resize 
      }

sample_map.yml

Maps a volume on the array to a host.

---
# Provide nimble_volume as parameter to map a block device to a host and attach it
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_host_name=myhost1
# sample_map.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: map
      }

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: attach
      }

sample_unmap.yml

Unmaps a volume on the array from a host.

---
# Provide nimble_volume as parameter to unmap a block device from a host and detach it
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_host_name=myhost1 \
# sample_unmap.yml

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: detach
      }

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: unmap
      }

sample_mount.yml

Mounts a volume that has been mapped to a host (creates a filesystem if there is none) and creates a fstab entry.

---
# Provide nimble_volume and nimble_volume_mountpoint as parameter and mount the volume
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_volume_mountpoint=/myvol1
# sample_mount.yml

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: mount 
      }

sample_umount.yml

Unmounts a filesystem and wipes fstab.

---
# Provide nimble_volume as parameter to unmount a volume (will not disconnect it)
# $ ansible-playbook -e nimble_volume=myvol1 \
# sample_unmount.yml

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: umount 
      }

sample_decommission.yml

Unmounts and deletes a volume.

---
# Provide nimble_volume and nimble_volume_mountpoint as extra vars, i.e:
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_volume_mountpoint=/mnt/myvol1 \
# -e nimble_host_name=myhost1
# sample_decommission.yml

- hosts: myhost1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: umount
      }
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: detach
      }

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: unmap 
      }
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volume,
        nimble_operation: delete 
      }

sample_array_setup.yml

Sets up and array from scratch over the network with ZeroConf.

---
# Provide nimble_array_serial as an extra variable and store config structure in host_vars/ansible_host
# $ ansible-playbook -e nimble_array_serial=XX-123456 \
# sample_array_setup.yml

- hosts: ansible_host
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: array,
        nimble_operation: setup
      }

sample_password_change.yml

Changes the password of a user.

---
# Provide nimble_password_new and nimble_password_user as extra vars
# $ ansible-playbook -e nimble_password_new=mynewpass-123 
# -e nimble_password_user=myusername 
# sample_password_change.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: password,
        nimble_operation: update }

Note: Changing the password of the that NLT user is currently connected to requires removing and re-adding the group. The NLT dependency for non-host related tasks such as "password update" will be removed in a future version.

sample_protect.yml

Protects a Nimble volume.

---
# Provide nimble_volume and nimble_volcoll OR nimble_protection_template as extra vars, i.e:
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_protection_template=Retain-30 
# sample_protect.yml
# $ ansible-playbook -e nimble_volume=myvol1 \
# -e nimble_volcoll=myexistingvolcoll \
# sample_protect.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: volume,
        nimble_operation: protect,
      }

sample_unprotect.yml

Disassociates a Nimble volume from a volume collection.

---
# Removes a volume from a volume collection
# $ ansible-playbook -e nimble_volume=myvol1 \
# sample_unprotect.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: volume,
        nimble_operation: unprotect
      }

sample_volcoll_create.yml

Creates a new volume collection.

---
# Create volume collection
# $ ansible-playbook -e nimble_volcoll=myvolcoll1 \
# -e nimble_protection_template=myprottmpl1 \
# sample_volcoll_create.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: volcoll,
        nimble_operation: create
      }

sample_volcoll_prune.yml

Prunes all empty volume collections.

---
# Prune volume collections without associated volumes
# $ ansible-playbook sample_volcoll_prune.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volcoll,
        nimble_operation: prune
      }

sample_volcoll_snapshot.yml

---
# Provide nimble_volcoll and nimble_volcoll_snapshot as extra vars, i.e:
# $ ansible-playbook -e nimble_volcoll=myvolcoll1 \
# -e nimble_volcoll_snapshot=mysnap1 \
# sample_volcoll_snapshot.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: volcoll,
        nimble_operation: snapshot 
      }

sample_prottmpl_create.yml

Creates a new protection template.

---
# Create default protection template 
# $ ansible-playbook -e nimble_protection_template=myprottmpl1 
# sample_prottmpl_create.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: prottmpl,
        nimble_operation: create
      }
  tags:
    - standalone

# Create protection template with schedules
# Please see InfoSight REST API docs for full schedule options
# Note: downstream_partner_id will be translated from a human-readable group name to an id
- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: prottmpl,
        nimble_operation: create,
        nimble_protection_schedules: {
          myschedule1: {
            description: "Create a snapshot hourly and retain 48",
            period_unit: "hours",
            period: 1,
            num_retain: 48
          },
          myschedule2: {
            description: "Create a snapshot every 5 minutes and retain 24",
            period_unit: "minutes",
            period: 5,
            num_retain: 24
          },
          myotherschedule: {
            downstream_partner_id: "group-nva2",
            num_retain_replica: 32,
            description: "Create a snapshot daily during weekdays at 1am and retain 16",
            period_unit: "days",
            days: "monday,tuesday,wednesday,thursday,friday",
            at_time: 3600,
            num_retain: 16
          }
        }
      }
  tags:
    - schedules

sample_prottmpl_delete.yml

Deletes a proection template.

---
# Delete protection template 
# $ ansible-playbook -e nimble_protection_template=myprottmpl1 \
# sample_prottmpl_delete.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: prottmpl,
        nimble_operation: delete
      }

sample_nimble_partner.yml

Partners with downstream Nimble array.

---
# Marry two arrays and test the connection
#
# Upstream variables defines how to partner the downstream
# Downstream variables defines how to partner upstream
#
# The nimble_partnerships var describes partnerships and should be protected with Ansible vault,
# please see defaults.yml of role for example
# 
# $ ansible-playbook -e nimble_partner=mypartnership \
# sample_nimble_partner.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: replication,
        nimble_operation: partner
      }

sample_nimble_divorce.yml

Divorces (deletes) a replication partnership.

---
# Divorce an array from another
#
# $ ansible-playbook -e nimble_partner=mypartner \
# sample_nimble_divorce.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: replication,
        nimble_operation: divorce
      }

sample_cloud_partner.yml

Partners a Nimble Storage array group with Cloud Volumes.

---
# Establish partnership with HPE Cloud Volumes
#
# $ ansible-playbook -e cloud_store_region \
# -e cloud_store=MyReplicationStore \
# sample_cloud_partner.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble,
        nimble_object: cloud,
        nimble_operation: partner
      }

sample_cloud_divorce.yml

Divorces a Nimble Storage array group from Cloud Volumes (leaves Replication Store intact)

---
# Break partnership with HPE Cloud Volumes Replication Store (leaves store intact)
# 
# $ ansible-playbook -e cloud_store=MyReplicationStore sample_cloud_divorce.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: cloud,
        nimble_operation: divorce
      }

sample_store_create.yml

Creates a Replication Store in Cloud Volumes.

---
# Creates a replication store of given size.
# Mind that creating Replication Stores does not assume any cloud instances
# Replication store is created in the context of an arbitray Ansible capable node
# $ ansible-playbook -e cloud_store=mycloudstore1 \
# -e cloud_store_size=300000 \
# -e cloud_store_region=us-west1 \
# sample_store_create.yml

- hosts: localhost
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: store,
        cloud_operation: create
      }

sample_store_delete.yml

Deletes a Replication Store in Cloud Volumes.

---
# Deletes a replication store
# Mind that deleted Replication Stores does not assume any cloud instances
# Replication stores are deleted in the context of an arbitrary Ansible capable node
# $ ansible-playbook -e cloud_store=mycloudstore1 \
# sample_store_delete.yml

- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: store,
        cloud_operation: delete
      }

sample_store_resize.yml

Resizes a Replication Store in Cloud Volumes.

---
# Resizes a replication store
# Mind that resizing replication stores does not assume any cloud instances 
# Replication store is resizedin the context of an arbitrary Ansible capable node
# $ ansible-playbook -e cloud_store=mycloudstore1 \
# -e cloud_store_size=20000 
# sample_store_resize.yml

- hosts: localhost
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: store,
        cloud_operation: resize
      }

sample_perfpolicy_create.yml

Creates a new Performance Policy.

---
# Creates a new performance policy with 4K block size, no compressionon or dedupe. 
# See API docs on HPE InfoSight for more valid options.
# $ ansible-playbook -e nimble_perfpolicy=myperfpol1 \
# -e nimble_perfpolicy_blocksize=4096 \
# sample_perfpolicy_create.yml

- hosts: myarray1
  vars:
    nimble_perfpolicy_options:
      compress: False
      dedupe_enabled: False
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: perfpolicy,
        nimble_operation: create
      }

sample_perfpolicy_update.yml

Updates a Performance Policy.

---
# Updates a performance policy, enables compression and dedupe.
# See API docs on HPE InfoSight for more valid options.
# $ ansible-playbook -e nimble_perfpolicy=myperfpol1 \
# sample_perfpolicy_update.yml

- hosts: myarray1
  vars:
    nimble_perfpolicy_update_options:
      compress: True
      dedupe_enabled: True
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: perfpolicy,
        nimble_operation: update
      }

sample_perfpolicy_delete.yml

Deletes a Performance Policy.

---
# Deletes a performance policy
# $ ansible-playbook -e nimble_perfpolicy=myperfpol1 \
# sample_perfpolicy_delete.yml

- hosts: myarray1
  roles:
    - { role: NimbleStorage.Ansinimble, 
        nimble_object: perfpolicy,
        nimble_operation: delete
      }

Cloud Volume Examples

These are some basic examples on how to use this role. Each example assumes credentials variables to HPE Cloud Volumes has been set elsewhere.

sample_install.yml

Installs Linux Connection Manager

---
- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble,
        cloud_object: lcm,
        cloud_operation: manage,
        cloud_lcm_state: present
      }

sample_provision.yml

Role stack example on how to provision a new Cloud Volume to an EC2 instance.

---
# Provisions a new barebone volume, maps and mounts it. Define cloud_volume in extra variable
# $ ansible-playbook -i ec2.py -l tag_cloudhost -e cloud_volume=mycloudvol1 sample_provision.yml
- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: create,
        cloud_volume_provider: "Amazon AWS",
        cloud_volume_region: "us-west-1",
        cloud_volume_options: {
          private_cloud: "vpc-00000000",
          existing_cloud_subnet: "172.31.0.0/16"
        }
      }
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: map,
        cloud_host_ip: "{{ ansible_default_ipv4.address }}"
      }
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: mount,
        cloud_volume_mountpoint: "/mnt/{{ cloud_volume }}"
      }

sample_resize.yml

Resizes a Cloud Volume and the host filesystem.

---
# Resizes a Cloud Volume, specify parameters as extra variables.
# $ ansible-playbook -i ec2.py -l tag_cloudhost -e cloud_volume=mycloudvol1 -e cloud_volume_size=30000 sample_resize.yml

- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: resize,
        cloud_volume_mountpoint: "/mnt/{{ cloud_volume }}"
      }

sample_update.yml

Sets a new IOPS limit on a Cloud Volume and enables multi-initiator. Full list of keys in cloud_volume_options are available in the Cloud Volumes API documentation.

---
# Sets an IOPS boundary and makes a Cloud Volume accessible from multiple initators, uses cloud_volume from -e
# $ ansible-playbook -i ec2.py -l tag_cloudhost -e cloud_volume=mycloudvol1 sample_update.yml

- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: update,
        cloud_volume_options: {
          iops: 1500,
          multi_initiator: True
        }
      }

sample_snapshot.yml

Snapshots a Cloud Volume with a named snapshot.

---
# Snapshots a Cloud Volume, specifies parametes in extra variables.
# $ ansible-playbook -i ec2.py -l tag_cloudhost -e cloud_volume=mycloudvol1 -e cloud_volume_snapshot=mysnap1 sample_snapshot.yml

- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: snapshot
      }

sample_restore.yml

Restores a Cloud Volume from a named snapshot.

---
# Restore a Cloud Volume, specifies parametes in extra variables.
# $ ansible-playbook -i ec2.py -l tag_cloudhost -e cloud_volume=mycloudvol1 -e cloud_volume_snapshot=mysnap1 sample_restore.yml

- hosts: all
  vars:
    cloud_host_ip: "{{ ansible_default_ipv4.address }}"
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: umount
      }
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: unmap,
      }
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: restore
      }
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: map,
      }
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: mount
      }

sample_clone_replica.yml

Creates a new Cloud Volume from a replica by cloning a snapshot.

---
# Clones a Replica Volume, specifies parametes in extra variables. Clones from latest (0) snapshot by default
# $ ansible-playbook -i ec2.py -l tag_cloudhost -e cloud_volume=mycloudvol1 -e cloud_replica=myreplicavol1 -e cloud_replica_snapshot_index=16 sample_clone_replica.yml
- hosts: all
  vars:
    cloud_host_ip: "{{ ansible_default_ipv4.address }}"
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: replica,
        cloud_operation: clone
      }

sample_decommission.yml

Fully decommissions a Cloud Volume from a host and deletes it.

---
# Fully decommisions a Cloud Volume. Define volume in cloud_volume.
# $ ansible-playbook -i ec2.py -l tag_cloudhost -e cloud_volume=mycloudvol1 sample_decommission.yml

- hosts: all
  vars:
    cloud_host_ip: "{{ ansible_default_ipv4.address }}"
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: umount,
        cloud_volume_mountpoint: "/mnt/{{ cloud_volume }}"
      }
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: unmap
      }
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: volume,
        cloud_operation: delete
      }

sample_uninstall.yml

Uninstalls the Linux Connection Manager.

---
- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble,
        cloud_object: lcm,
        cloud_operation: manage,
        cloud_lcm_state: absent
      }

sample_debug.yml

Croaks out all HPE Cloud Volume Portal facts into cloud_portal_facts

---
- hosts: all
  roles:
    - { role: NimbleStorage.Ansinimble, 
        cloud_object: portal,
        cloud_operation: facts
      }
  tasks:
    - debug: 
        var: cloud_portal_facts
    - debug: 
        var: cloud_host_facts

Security considerations

Always secure your nimble_group_password and other sensitive variables with Ansible Vault to prevent eavesdropping.

Contributing

Please feel free to submit pull requests. Include a test in tests/nimble/test.yml for local Nimble arrays and tests/cloud/cloud.yml if including new functionality. Tests are run manually before merge.

License

Apache 2.0, please see LICENSE

Version

Please see VERSION

Author Information

This role is maintained by Michael Mattsson, a HPE Nimble Storage employee, on Nimble Hack Days. Please use the GitHub issue tracker for any queries related to this role.

Name		Name	Last commit message	Last commit date
Latest commit History 85 Commits
defaults		defaults
examples		examples
handlers		handlers
meta		meta
tasks		tasks
templates		templates
tests		tests
vars		vars
LICENSE		LICENSE
README.md		README.md
VERSION		VERSION

License

NimbleStorage/ansinimble

Folders and files

Latest commit

History

Repository files navigation

Deprecation notice

NimbleStorage.Ansinimble

Requirements

Nimble Arrays

Cloud Volumes

Deprecation notes and tested versions of Ansible

Breaking changes between releases

Documentation

Reference documentation

Role Variables

Usage

Nimble Storage Array Operations

nimble_object nimble_operation

folder create

folder update

folder delete

volume create

volume update

volume map

volume attach

volume mount

volume resize

volume snapshot

snapshot update

volume umount

volume unmap

volume detach

volume restore

volume delete

volume protect

volume unprotect

volcoll create

volcoll prune

volcoll snapshot

prottmpl create

prottmpl delete

replication partner

replication divorce

cloud partner

cloud divorce

host facts

group facts

group update

group cli

nlt manage

array setup

password update

perfpolicy create

perfpolicy update

perfpolicy delete

Cloud Volume Operations

cloud_object cloud_operation

volume create

volume update

volume map

volume mount

volume resize

volume snapshot

volume umount

volume unmap

volume restore

volume delete

store create

store resize

store delete

replica clone

portal facts

lcm manage

host facts

Example Playbooks

Nimble Storage Array Group Examples

Cloud Volume Examples

Security considerations

Contributing