brocade.fos.brocade_singleton_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 list of attributes based on module name and object name provided

Inputs

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

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

obj_name:
    description:
    - Yang name for the 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

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

attributes:
    description:
    - List of attributes for the object. names match rest attributes with "-" replaced
      with "_". Using hyphen in the name may result in errenously behavior based on ansible
      parsing. - Special node for "brocade-security" module "password" object "old_password"
      and "new_password" are in plain text. If "user_name" is user account, only "new_password"
      is needed.
    required: true
    type: dict

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

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

Outputs

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