brocade.fos.brocade_zoning_alias (1.3.3) — module

Install collection

Install with ansible-galaxy collection install brocade.fos:==1.3.3

Add to requirements.yml

  collections:
    - name: brocade.fos
      version: 1.3.3

Description

Create, detroy, or update aliases. The whole of aliases and aliases_to_delete are applied to FOS within a single login session to termininate after the completion. If no active cfg is found, cfgsave is executed before the completion of the session. If an active cfg is found, cfgenable of the existing cfg is executed to apply any potential changes before the completion of the session.

Inputs

    
vfid:
    description:
    - VFID of the switch. Use -1 for FOS without VF enabled or AG.
    required: false
    type: int

aliases:
    description:
    - List of aliases to be created or modified. If an alias does not exist in the current
      Zone Database, the alias will be created with the members specified. If an alias
      already exist in the current Zone Database, the alias is updated to reflect to members
      specificed. In other word, new members will be added and removed members will be
      removed. If no aliases_to_delete are listed, aliases is required. aliases_to_delete
      and aliases are mutually exclusive.
    required: false
    type: list

timeout:
    description:
    - REST timeout in seconds for operations that take longer than FOS default value.
    type: int

throttle:
    description:
    - Throttling delay in seconds. Enables second retry on first failure.
    type: int

credential:
    description:
    - Login information
    required: true
    suboptions:
      fos_ip_addr:
        description:
        - IP address of the FOS switch
        required: true
        type: str
      fos_password:
        description:
        - Password of FOS switch
        required: true
        type: str
      fos_user_name:
        description:
        - Login name of FOS switch
        required: true
        type: str
      https:
        choices:
        - true
        - false
        - self
        description:
        - Encryption to use. True for HTTPS, self for self-signed HTTPS, or False for
          HTTP
        required: true
        type: str
    type: dict

members_add_only:
    description:
    - If set to True, new members will be added and old members not specified also remain.
    required: false
    type: bool

aliases_to_delete:
    description:
    - List of aliases to be deleted. If no aliases are listed, aliases_to_delete is required.  aliases_to_delete
      and aliases are mutually exclusive.
    required: false
    type: list

members_remove_only:
    description:
    - If set to True, members specified are removed.
    required: false
    type: bool

Outputs

msg:
  description: Success message
  returned: success
  type: str