brocade.fos.brocade_list_obj (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

Update Fibre Channel list of objects based on module name and list name provided

Inputs

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

entries:
    description:
    - List of objects. Name of each attributes within each entries should match the Yang
      name except hyphen is replaced with underscore. Using hyphen in the name may result
      in errenously behavior based on Ansible parsing.
    required: true
    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

list_name:
    description:
    - Yang name for the list object. Hyphen or underscore are used interchangebly. If
      the Yang list name is xy-z, either xy-z or xy_z are acceptable.
    required: true
    type: str

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

all_entries:
    description:
    - Boolean to indicate if the entries specified are full list of objects or not. By
      default, all_entries are thought to be true if not specified. If all_entries is
      set to true, the entries is used to calculate the change of existing entryies, addition,
      and deletion. If all_entries is set to false, the entries is used to calculate the
      change of existing entries and addition of entries only. i.e.  the module will not
      attempt to delete objects that do not show up in the entries.
    required: false
    type: bool

module_name:
    description:
    - Yang module name. Hyphen or underscore are used interchangebly. If the Yang module
      name is xy-z, either xy-z or xy_z are acceptable.
    required: true
    type: str

delete_entries:
    description:
    - name of the entries to be deleted. mutually exclusive with entries.
    required: false

Outputs

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