dellemc.unity.tree_quota (2.0.0) — module

Manage quota tree on the Unity storage system

| "added in version" 1.2.0 of dellemc.unity"

Authors: Spandita Panigrahi (@panigs7) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.unity:==2.0.0


Add to requirements.yml

  collections:
    - name: dellemc.unity
      version: 2.0.0

Description

Managing Quota tree on the Unity storage system includes Create quota tree, Get quota tree, Modify quota tree and Delete quota tree.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get quota tree details by quota tree id
  dellemc.unity.tree_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    tree_quota_id: "treequota_171798700679_10"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get quota tree details by quota tree path
  dellemc.unity.tree_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "fs_2171"
    nas_server_id: "nas_21"
    path: "/test"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create quota tree for a filesystem with filesystem id
  dellemc.unity.tree_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    hard_limit: 6
    cap_unit: "TB"
    soft_limit: 5
    path: "/test_new"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create quota tree for a filesystem with filesystem name
  dellemc.unity.tree_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_name: "Test_filesystem"
    nas_server_name: "lglad068"
    hard_limit: 6
    cap_unit: "TB"
    soft_limit: 5
    path: "/test_new"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify quota tree limit usage by quota tree path
  dellemc.unity.tree_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    path: "/test_new"
    hard_limit: 10
    cap_unit: "TB"
    soft_limit: 8
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify quota tree by quota tree id
  dellemc.unity.tree_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    tree_quota_id: "treequota_171798700679_10"
    hard_limit: 12
    cap_unit: "TB"
    soft_limit: 10
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete quota tree by quota tree id
  dellemc.unity.tree_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    tree_quota_id: "treequota_171798700679_10"
    state: "absent"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete quota tree by path
  dellemc.unity.tree_quota:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    filesystem_id: "fs_2171"
    path: "/test_new"
    state: "absent"

Inputs

    
path:
    description:
    - The path to the quota tree.
    - Either I(tree_quota_id) or I(path) to quota tree is required to create/view/modify/delete
      a quota tree.
    - Path must start with a forward slash '/'.
    type: str

port:
    default: 443
    description:
    - Port number through which communication happens with Unity management server.
    type: int

state:
    choices:
    - absent
    - present
    description:
    - The state option is used to mention the existence of the filesystem quota tree.
    required: true
    type: str

cap_unit:
    choices:
    - MB
    - GB
    - TB
    description:
    - Unit of I(soft_limit) and I(hard_limit) size.
    - It defaults to C(GB) if not specified.
    type: str

password:
    description:
    - The password of the Unity management server.
    required: true
    type: str

username:
    description:
    - The username of the Unity management server.
    required: true
    type: str

hard_limit:
    description:
    - Hard limitation for a quota tree on the total space available. If exceeded, users
      in quota tree cannot write data.
    - Value C(0) implies no limit.
    - One of the values of I(soft_limit) and I(hard_limit) can be C(0), however, both
      cannot be both C(0) during creation of a quota tree.
    type: int

soft_limit:
    description:
    - Soft limitation for a quota tree on the total space available. If exceeded, notification
      will be sent to users in the quota tree for the grace period mentioned, beyond which
      users cannot use space.
    - Value C(0) implies no limit.
    - Both I(soft_limit) and I(hard_limit) cannot be C(0) during creation of quota tree.
    type: int

description:
    description:
    - Description of a quota tree.
    type: str

filesystem_id:
    description:
    - The ID of the filesystem for which the quota tree is created.
    - For creation of a quota tree either I(filesystem_id) or I(filesystem_name) is required.
    type: str

nas_server_id:
    description:
    - The ID of the NAS server in which the filesystem is created.
    - For creation of a quota tree either I(filesystem_id) or I(filesystem_name) is required.
    type: str

tree_quota_id:
    description:
    - The ID of the quota tree.
    - Either I(tree_quota_id) or I(path) to quota tree is required to view/modify/delete
      quota tree.
    type: str

unispherehost:
    description:
    - IP or FQDN of the Unity management server.
    required: true
    type: str

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether or not to validate SSL certificate.
    - C(true) - Indicates that the SSL certificate should be verified.
    - C(false) - Indicates that the SSL certificate should not be verified.
    type: bool

filesystem_name:
    description:
    - The name of the filesystem for which quota tree is created.
    - For creation or modification of a quota tree either I(filesystem_name) or I(filesystem_id)
      is required.
    type: str

nas_server_name:
    description:
    - The name of the NAS server in which the filesystem is created.
    - For creation of a quota tree either I(nas_server_name) or I(nas_server_id) is required.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: true
  type: bool
get_tree_quota_details:
  contains:
    description:
      description: Description of the quota tree.
      type: str
    filesystem:
      contains:
        UnityFileSystem:
          contains:
            id:
              description: ID of the filesystem for which the quota tree is create.
              type: str
          description: Filesystem details for which the quota tree is created.
          type: dict
      description: Filesystem details for which the quota tree is created.
      type: dict
    gp_left:
      description: The grace period left after the soft limit for the user quota is
        exceeded.
      type: int
    hard_limit:
      description: Hard limit of quota tree. If the quota tree's space usage exceeds
        the hard limit, users in quota tree cannot write data.
      type: int
    id:
      description: Quota tree ID.
      type: str
    path:
      description: Path to quota tree. A valid path must start with a forward slash
        '/'. It is mandatory while creating a quota tree.
      type: str
    size_used:
      description: Size of used space in the filesystem by the user files.
      type: int
    soft_limit:
      description: Soft limit of the quota tree. If the quota tree's space usage exceeds
        the soft limit, the storage system starts to count down based on the specified
        grace period.
      type: int
    state:
      description: State of the quota tree.
      type: int
  description: Details of the quota tree.
  returned: When quota tree exists
  sample:
    description: ''
    existed: true
    filesystem:
      UnityFileSystem:
        hash: 8788549469862
        id: fs_137
        name: test
        nas_server:
          id: nas_1
          name: lglad072
    gp_left: null
    hard_limit: 6.0 TB
    hash: 8788549497558
    id: treequota_171798694897_1
    path: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
    size_used: 0
    soft_limit: 5.0 TB
    state: 0
  type: dict