ctera.ctera.ctera_portal_plan (2.2.17) — module

CTERA-Networks Portal Plan configuration and management

Authors: Saimon Michelson (@saimonation), Ygal Blum (@ygalblum)

preview | supported by community

Install collection

Install with ansible-galaxy collection install ctera.ctera:==2.2.17


Add to requirements.yml

  collections:
    - name: ctera.ctera
      version: 2.2.17

Description

Create, modify and delete plans.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Portal Plan
  ctera_portal_plan:
    name: 'example'
    retention:
    - policy_name: retainAll
      duration: 24
    quotas:
    - item_name: EV16
      amount: 100
    ctera_host: "{{ ctera_portal_hostname }}"
    ctera_user: "{{ ctera_portal_user }}"
    ctera_password: "{{ ctera_portal_password }}"

Inputs

    
name:
    description: The name of the plan
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the specified plan should exist or not.
    type: str

quotas:
    description: The items included in the plan and their respective quota
    elements: dict
    suboptions:
      amount:
        description: The quota's amount
        required: true
        type: int
      item_name:
        choices:
        - EV4
        - EV8
        - EV16
        - EV32
        - EV64
        - EV128
        - WA
        - SA
        - Share
        - Connect
        - Storage
        description: The name of the plan item
        required: true
        type: str
    type: list

tenant:
    description:
    - Name of the tenant.
    - For Global Admin operations set to "$admin"
    - Use default if not provided.
    - Do not set for initialization operations
    type: str

retention:
    description: The data retention policy
    elements: dict
    suboptions:
      duration:
        description: The duration for the policy
        required: true
        type: int
      policy_name:
        choices:
        - retainAll
        - hourly
        - daily
        - weekly
        - monthly
        - quarterly
        - yearly
        - retainDeleted
        description: The name of the policy
        required: true
        type: str
    type: list

Outputs

name:
  description: Name of the Plan
  returned: when state is present
  sample: example
  type: str