purestorage.flashblade.purefb_fs (1.17.0) — module

Manage filesystemon Pure Storage FlashBlade`

| "added in version" 1.0.0 of purestorage.flashblade"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install purestorage.flashblade:==1.17.0


Add to requirements.yml

  collections:
    - name: purestorage.flashblade
      version: 1.17.0

Description

This module manages filesystems on Pure Storage FlashBlade.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create new filesystem named foo
  purestorage.flashblade.purefb_fs:
    name: foo
    size: 1T
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete filesystem named foo
  purestorage.flashblade.purefb_fs:
    name: foo
    state: absent
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Recover filesystem named foo
  purestorage.flashblade.purefb_fs:
    name: foo
    state: present
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Eradicate filesystem named foo
  purestorage.flashblade.purefb_fs:
    name: foo
    state: absent
    eradicate: true
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Promote filesystem named foo ready for failover
  purestorage.flashblade.purefb_fs:
    name: foo
    promote: true
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Demote filesystem named foo after failover
  purestorage.flashblade.purefb_fs:
    name: foo
    promote: false
    fb_url: 10.10.10.2
    api_token: T-55a68eb5-c785-4720-a2ca-8b03903bf641
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify attributes of an existing filesystem named foo
  purestorage.flashblade.purefb_fs:
    name: foo
    size: 2T
    nfsv3 : false
    nfsv4 : true
    user_quota: 10K
    group_quota: 25M
    nfs_rules: '10.21.200.0/24(ro)'
    snapshot: true
    fastremove: true
    hard_limit: true
    smb: true
    state: present
    fb_url: 10.10.10.2

Inputs

    
smb:
    default: false
    description:
    - Define whether to SMB protocol is enabled for the filesystem.
    required: false
    type: bool

http:
    default: false
    description:
    - Define whether to HTTP/HTTPS protocol is enabled for the filesystem.
    required: false
    type: bool

name:
    description:
    - Filesystem Name.
    required: true
    type: str

size:
    description:
    - Volume size in M, G, T or P units. See examples.
    - If size is not set at filesystem creation time the filesystem size becomes unlimited.
    required: false
    type: str

nfsv3:
    default: true
    description:
    - Define whether to NFSv3 protocol is enabled for the filesystem.
    required: false
    type: bool

nfsv4:
    default: true
    description:
    - Define whether to NFSv4.1 protocol is enabled for the filesystem.
    required: false
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Create, delete or modifies a filesystem.
    required: false
    type: str

fb_url:
    description:
    - FlashBlade management IP address or Hostname.
    type: str

policy:
    description:
    - Filesystem policy to assign to or remove from a filesystem.
    required: false
    type: str

promote:
    description:
    - Promote/demote a filesystem.
    - Can only demote the file-system if it is in a replica-link relationship.
    required: false
    type: bool

snapshot:
    default: false
    description:
    - Define whether a snapshot directory is enabled for the filesystem.
    required: false
    type: bool

writable:
    description:
    - Define if a filesystem is writeable.
    required: false
    type: bool

api_token:
    description:
    - FlashBlade API token for admin privileged user.
    type: str

eradicate:
    default: false
    description:
    - Define whether to eradicate the filesystem on delete or leave in trash.
    required: false
    type: bool

nfs_rules:
    description:
    - Define the NFS rules in operation.
    - If not set at filesystem creation time it defaults to I(*(rw,no_root_squash))
    - Supported binary options are ro/rw, secure/insecure, fileid_32bit/no_fileid_32bit,
      root_squash/no_root_squash, all_squash/no_all_squash and atime/noatime
    - Supported non-binary options are anonuid=#, anongid=#, sec=(sys|krb5)
    - Superceeded by I(export_policy) if provided
    required: false
    type: str

fastremove:
    default: false
    description:
    - Define whether the fast remove directory is enabled for the filesystem.
    required: false
    type: bool

hard_limit:
    default: false
    description:
    - Define whether the capacity for a filesystem is a hard limit.
    - CAUTION This will cause the filesystem to go Read-Only if the capacity has already
      exceeded the logical size of the filesystem.
    required: false
    type: bool

user_quota:
    description:
    - Default quota in M, G, T or P units for a user under this file system.
    required: false
    type: str

delete_link:
    default: false
    description:
    - Define if the filesystem can be deleted even if it has a replica link
    required: false
    type: bool

group_quota:
    description:
    - Default quota in M, G, T or P units for a group under this file system.
    required: false
    type: str

smb_aclmode:
    choices:
    - shared
    - native
    default: shared
    description:
    - Specify the ACL mode for the SMB protocol.
    - Deprecated from Purity//FB 3.1.1. Use I(access_control) instead.
    required: false
    type: str

policy_state:
    choices:
    - absent
    - present
    default: present
    description:
    - Add or delete a policy from a filesystem
    required: false
    type: str

share_policy:
    description:
    - Name of SMB share policy to assign to filesystem
    - Only valid with REST 2.10 or higher
    - Remove policy with empty string
    type: str
    version_added: 1.12.0
    version_added_collection: purestorage.flashblade

client_policy:
    description:
    - Name of SMB client policy to assign to filesystem
    - Only valid with REST 2.10 or higher
    - Remove policy with empty string
    type: str
    version_added: 1.12.0
    version_added_collection: purestorage.flashblade

discard_snaps:
    default: false
    description:
    - Allow a filesystem to be demoted.
    required: false
    type: bool

export_policy:
    description:
    - Name of NFS export policy to assign to filesystem
    - Overrides I(nfs_rules)
    - Only valid for Purity//FB 3.3.0 or higher
    type: str
    version_added: 1.9.0
    version_added_collection: purestorage.flashblade

access_control:
    choices:
    - nfs
    - smb
    - shared
    - independent
    - mode-bits
    default: shared
    description:
    - The access control style that is utilized for client actions such as setting file
      and directory ACLs.
    - Only available from Purity//FB 3.1.1
    type: str

safeguard_acls:
    default: true
    description:
    - Safeguards ACLs on a filesystem.
    - Performs different roles depending on the filesystem protocol enabled.
    - See Purity//FB documentation for detailed description.
    - Only available from Purity//FB 3.1.1
    type: bool

group_ownership:
    choices:
    - creator
    - parent-directory
    description:
    - The group ownership for new files and directories in a file system
    type: str
    version_added: 1.17.0
    version_added_collection: purestorage.flashblade

continuous_availability:
    default: true
    description:
    - Defines if the file system will be continuously available during disruptive scenarios
      such as network disruption, blades failover, etc
    type: bool
    version_added: 1.15.0
    version_added_collection: purestorage.flashblade