broadcom.file_master_plus.populate_data_set (5.0.9) — module

Install collection

Install with ansible-galaxy collection install broadcom.file_master_plus:==5.0.9

Add to requirements.yml

  collections:
    - name: broadcom.file_master_plus
      version: 5.0.9

Description

Populate a specific data set with records.

The layout of the records to add are described by a Cobol or PL/I copybook.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Populating a data set
  broadcom.file_master_plus.populate_data_set:
    name: fmmvs.dsname
    layout_member: testlay
    layout_data_set: fmmvs.layout.dataset
    data: ../instream/data1.txt

Inputs

    
data:
    description:
    - Specifies path of the .txt/.json file of the data stream. Ensure the data stream
      is an array in JSON format represented by a layout data set and its member.
    - 'Example: ../instream/data1.txt .'
    required: true
    type: str

host:
    description:
    - Specifies File Master Plus server host name.
    required: false
    type: str

name:
    description:
    - Specifies the name of the data set to populate.
    required: true
    type: str

port:
    default: 51914
    description:
    - Specifies File Master Plus server port.
    required: false
    type: int

user:
    description:
    - Specifies Mainframe user name. May be the same as TSO login.
    required: false
    type: str

member:
    description:
    - Specifies name of the member.
    - 'Note: Used only if the specified data set is a PDS or PDSE.'
    - 'Example: member1.'
    required: false
    type: str

password:
    description:
    - Specifies Mainframe password. May be the same as TSO password.
    required: false
    type: str

protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Specifies File Master Plus REST API protocol.
    required: false
    type: str

base_path:
    description:
    - The base path for your Zowe API Mediation Layer instance. Specify this option to
      prepend the base path to all FMP resources when making REST requests. Do not specify
      this option if you are not using an Zowe API Mediation Layer.
    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

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

layout_member:
    description:
    - Specifies the name of the Cobol or PL/I copybook.
    - 'Example: testlay.'
    required: true
    type: str

layout_data_set:
    description:
    - Specifies the name of the data set that contains the layout member.
    - 'Example: fmmvs.layout.dataset.'
    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