broadcom.view.list_report_index_values (2.0.8) — module

Install collection

Install with ansible-galaxy collection install broadcom.view:==2.0.8

Add to requirements.yml

  collections:
    - name: broadcom.view
      version: 2.0.8

Description

List index values for a report index.

Use the returned 'ReportHandle' to reference an index value in other commands.

For example, use 'ReportHandle' in the 'download report' command to download that corresponding view of the report.

Inputs

    
host:
    description:
    - Hostname or ip address of the target View REST API instance.
    required: false
    type: str

port:
    default: 443
    description:
    - Port of the target View REST API instance.
    required: false
    type: int

user:
    description:
    - User name used to authenticate against the target View REST API instance.
    required: false
    type: str

password:
    description:
    - Password used to authenticate against the target View REST API instance.
    required: false
    type: str

protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Protocol of the target View REST API instance.
    required: false
    type: str

base_path:
    default: web-viewer
    description:
    - Context name of the target View REST API instance.
    required: false
    type: str

cert_file:
    description:
    - The file path to a certificate file to use for authentication.
    - ''
    - 'Note: The CLI does not support certificate files that require a password. For more
      information, search Troubleshooting PEM Certificates in Zowe Docs.'
    required: false
    type: path

output_field:
    default:
    - Value
    - SubValues
    - ReportHandle
    description:
    - Field to include in the output. Multiple fields can be specified.
    - Fields appear in the order you specify.
    - ''
    - 'Allowed values: Value,SubValues,ReportHandle.'
    elements: str
    required: false
    type: list

cert_key_file:
    description:
    - The file path to a certificate key file to use for authentication.
    required: false
    type: path

filter_values:
    default: '*,*,*,*,*,*,*,*'
    description:
    - Filter (include) based on index values. Separate index values with commas. Use the
      asterisk (*) as a wildcard to represent any number of characters.
    required: false
    type: str

output_format:
    choices:
    - ^tabular$
    - ^csv$
    - ^json$
    - ^xml$
    default: tabular
    description:
    - Output format. This option is ignored if '--response-format-json' is specified.
    required: false
    type: str

output_header:
    default: true
    description:
    - Include header with field names in the output when you specify 'tabular' or 'csv'
      for the output format.
    - This option is ignored when you specify any other output format.
    required: false
    type: bool

report_handle:
    description:
    - Report handle.
    required: true
    type: str

repository_id:
    description:
    - Repository identifier.
    required: true
    type: int

index_name_handle:
    description:
    - Index name handle.
    required: true
    type: str

reject_unauthorized:
    default: true
    description:
    - Reject self-signed certificates.
    required: false
    type: bool

Outputs

data:
  description: Data from the module execution (a data structure). The items of this
    dict are set as individual return values on the top level as well.
  elements: dict
  returned: when returned data is a dictionary
  type: list
error:
  contains:
    additional_details:
      description: Detailed message about the failure.
      type: str
    msg:
      description: Short description of the result or failure.
      type: str
    request:
      description: HTTP method used to invoke API service request.
      returned: API request failed
      type: str
    resource:
      description: URI of the resource of the API service request.
      returned: API request failed
      type: str
  description: More details about why the action has failed. If the failure is when
    calling an API service, the response contains the connection parameters.
  returned: error
  type: complex
failed:
  description: A boolean that indicates if the task was failed or not.
  returned: always
  type: bool
list:
  description: Data from the module execution (a list of data structures).
  elements: dict
  returned: when returned data is a list
  type: list
msg:
  description: Short description of the result or failure.
  returned: sometimes
  type: str
rc:
  description: Exit code of the module, successful exit code is 0, failure is typically
    1 or higher.
  returned: always
  type: int
stderr:
  description: Details of the error.
  returned: error
  type: str
stdout:
  description: Summary of the result.
  returned: success
  type: str