ansible.builtin.purefa_host (v2.9.27) — module

Manage hosts on Pure Storage FlashArrays

| "added in version" 2.4 of ansible.builtin"

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Create, delete or modify hosts on Pure Storage FlashArrays.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create new AIX host
  purefa_host:
    host: foo
    personaility: aix
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete host
  purefa_host:
    host: foo
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Make host bar with wwn ports
  purefa_host:
    host: bar
    protocol: fc
    wwns:
    - 00:00:00:00:00:00:00
    - 11:11:11:11:11:11:11
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Make host bar with iSCSI ports
  purefa_host:
    host: bar
    protocol: iscsi
    iqn:
    - iqn.1994-05.com.redhat:7d366003913
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Make host bar with NVMe ports
  purefa_host:
    host: bar
    protocol: nvme
    nqn:
    - nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-d78432
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Make mixed protocol host
  purefa_host:
    host: bar
    protocol: mixed
    nqn:
    - nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-d78432
    iqn:
    - iqn.1994-05.com.redhat:7d366003914
    wwns:
    - 00:00:00:00:00:00:01
    - 11:11:11:11:11:11:12
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Map host foo to volume bar as LUN ID 12
  purefa_host:
    host: foo
    volume: bar
    lun: 12
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add preferred arrays to host foo
  purefa_host:
    host: foo
    preferred_array:
    - array1
    - array2
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete preferred arrays from host foo
  purefa_host:
    host: foo
    preferred_array: delete
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Inputs

    
iqn:
    description:
    - List of IQNs of the host if protocol is iscsi or mixed.
    type: list

lun:
    description:
    - LUN ID to assign to volume for host. Must be unique.
    - If not provided the ID will be automatically assigned.
    - Range for LUN ID is 1 to 4095.
    type: int
    version_added: '2.8'
    version_added_collection: ansible.builtin

nqn:
    description:
    - List of NQNs of the host if protocol is nvme or mixed.
    type: list
    version_added: '2.8'
    version_added_collection: ansible.builtin

host:
    description:
    - The name of the host.
    required: true
    type: str

wwns:
    description:
    - List of wwns of the host if protocol is fc or mixed.
    type: list

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Define whether the host should exist or not.
    - When removing host all connected volumes will be disconnected.
    type: str

fa_url:
    description:
    - FlashArray management IPv4 address or Hostname.
    required: true
    type: str

volume:
    description:
    - Volume name to map to the host.
    type: str

protocol:
    choices:
    - fc
    - iscsi
    - nvme
    - mixed
    default: iscsi
    description:
    - Defines the host connection protocol for volumes.
    type: str

api_token:
    description:
    - FlashArray API token for admin privileged user.
    required: true
    type: str

personality:
    choices:
    - hpux
    - vms
    - aix
    - esxi
    - solaris
    - hitachi-vsp
    - oracle-vm-server
    - delete
    - ''
    default: ''
    description:
    - Define which operating system the host is. Recommended for ActiveCluster integration.
    type: str
    version_added: '2.7'
    version_added_collection: ansible.builtin

preferred_array:
    description:
    - List of preferred arrays in an ActiveCluster environment.
    - To remove existing preferred arrays from the host, specify I(delete).
    type: list
    version_added: '2.9'
    version_added_collection: ansible.builtin