brocade.fos.brocade_facts (1.3.3) — module

Brocade Fibre Channel facts gathering

| "added in version" 2.6 of brocade.fos"

Authors: Broadcom BSN Ansible Team <Automation.BSN@broadcom.com>

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

Gather FOS facts

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

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

gather_subset:
    choices:
    - all
    - brocade_access_gateway_port_group
    - brocade_access_gateway_n_port_map
    - brocade_access_gateway_f_port_list
    - brocade_access_gateway_device_list
    - brocade_access_gateway_policy
    - brocade_access_gateway_n_port_settings
    - brocade_zoning
    - brocade_interface_fibrechannel
    - brocade_chassis_chassis
    - brocade_fibrechannel_configuration_fabric
    - brocade_fibrechannel_configuration_port_configuration
    - brocade_fibrechannel_switch
    - brocade_fibrechannel_trunk_trunk
    - brocade_fibrechannel_trunk_performance
    - brocade_fibrechannel_trunk_trunk_area
    - brocade_time_clock_server
    - brocade_time_time_zone
    - brocade_logging_syslog_server
    - brocade_logging_audit
    - brocade_media_media_rdp
    - brocade_snmp_system
    - brocade_security_ipfilter_rule
    - brocade_security_ipfilter_policy
    - brocade_security_user_config
    - brocade_security_password_cfg
    - brocade_security_security_certificate
    - brocade_snmp_v1_account
    - brocade_snmp_v1_trap
    - brocade_snmp_v3_account
    - brocade_snmp_v3_trap
    - brocade_maps_maps_config
    - brocade_security_sec_crypto_cfg_template_action
    - brocade_security_sshutil_public_key
    - brocade_security_ldap_role_map
    default: all
    description:
    - List of areas to be gathered. If this option is missing, all areas' facts will be
      gathered. Same behavior applies if "all" is listed as part of gather_subset.
    required: false
    type: list

Outputs

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