dellemc.powerscale.dellemc_powerscale_networkrule (1.4.0) — module

Manages Network provisioning rules for DellEMC PowerScale Storage

| "added in version" 1.4.0 of dellemc.powerscale"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install dellemc.powerscale:==1.4.0


Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 1.4.0

Description

Modify an existing network provisioning rule Create a new network provisioning rule Delete a network provisioning rule View the details of a network provisioning rule


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: Get the details of a network rule
    dellemc_powerscale_network_rule:
      onefs_host: "{{onefs_host}}"
      port_no: "{{port_no}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet1"
      subnet_name: "subnet1"
      pool_name: "pool1"
      rule_name: "rule1"
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Create a new network provisioning rule
    dellemc_powerscale_network_rule:
      onefs_host: "{{onefs_host}}"
      port_no: "{{port_no}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet1"
      subnet_name: "subnet1"
      pool_name: "pool1"
      rule_name: "new_rule"
      description: "Rename existing rule"
      iface: "ext1"
      node_type: "storage"
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Modifying an existing network provisioning rule
    dellemc_powerscale_network_rule:
      onefs_host: "{{onefs_host}}"
      port_no: "{{port_no}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet1"
      subnet_name: "subnet1"
      pool_name: "pool1"
      rule_name: "rule_name"
      description: "Modify rule"
      iface: "ext1"
      node_type: "storage"
      state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Delete a network provisioning rule
    dellemc_powerscale_network_rule:
      onefs_host: "{{onefs_host}}"
      port_no: "{{port_no}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      verify_ssl: "{{verify_ssl}}"
      groupnet_name: "groupnet1"
      subnet_name: "subnet1"
      pool_name: "pool1"
      rule_name: "rule"
      state: absent

Inputs

    
iface:
    description:
    - Interface to which the rule applies
    type: str

state:
    choices:
    - absent
    - present
    description: State of provisioning rule
    required: true
    type: str

port_no:
    default: '8080'
    description:
    - Port number of the PowerScale cluster.It defaults to 8080 if not specified.
    required: false
    type: str

api_user:
    description:
    - username of the PowerScale cluster.
    required: true
    type: str

node_type:
    choices:
    - any
    - storage
    - accelerator
    - backup-accelerator
    description:
    - Node types to which the provisioning rule applies
    type: str

pool_name:
    description: Pool to which this provisioning rule applies
    required: true
    type: str

rule_name:
    description: Name of provisioning rule
    required: true
    type: str

onefs_host:
    description:
    - IP address or FQDN of the PowerScale cluster.
    required: true
    type: str

verify_ssl:
    choices:
    - true
    - false
    description:
    - boolean variable to specify whether to validate SSL certificate or not.
    - True - indicates that the SSL certificate should be verified.
    - False - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

description:
    description:
    - Description for rule
    - It can be no more than 128 bytes in length
    type: str

subnet_name:
    description: Name of the subnet to which this provisioning rule applies
    required: true
    type: str

api_password:
    description:
    - the password of the PowerScale cluster.
    required: true
    type: str

groupnet_name:
    description: Groupnet name to which this provisioning rule applies
    required: true
    type: str

new_rule_name:
    description: Name of provisioning rule when renaming an existing rule
    type: str

Outputs

changed:
  description: Whether or not the resource has changed
  returned: Always
  type: bool
network_rule_details:
  contains:
    description:
      description: Description of network provisioning rule
      type: str
    groupnet:
      description: Name of groupnet to which this rule belongs
      type: str
    id:
      description: Unique ID for network provisioning rule
      type: str
    iface:
      description:
      - Interface name to which this rule belongs
      - For example, ext-1
      type: str
    name:
      description: Name of network provisioning rule
      type: str
    node_type:
      description:
      - Node type to which the provisioning rule applies
      type: str
    pool:
      description: Name of pool to which this rule belongs
      type: str
    subnet:
      description: Name of subnet to which this rule belongs
      type: str
  description: Network provisioning rule details
  returned: When a network provisioning rule exists
  type: complex