broadcom / broadcom.file_master_plus / 5.0.9 / module / copy_data_set Copy a data set | "added in version" 1.0.0 of broadcom.file_master_plus" Authors: Petr Galik <petr.galik@broadcom.com> (@broadcom) | supported by Broadcom This plugin has a corresponding action plugin.broadcom.file_master_plus.copy_data_set (5.0.9) — module
Install with ansible-galaxy collection install broadcom.file_master_plus:==5.0.9
collections: - name: broadcom.file_master_plus version: 5.0.9
Copy from a data set to another data set.
If the <to> data set does not exist, File Master Plus automatically creates a new data set using the attributes of <from> data set.
It supports all data set types that are supported by File Master Plus.
- name: Copying a data set broadcom.file_master_plus.copy_data_set: from: fmmvs.pds1 to: fmmvs.pds2
- name: Copying a data set with dynamic selection criteria broadcom.file_master_plus.copy_data_set: from: fmmvs.from.ps to: fmmvs.to.ps dynamic_selection_criteria: ./fmmvs/selcri/testcri layout_member: testlay layout_data_set: fmmvs.layout.dataset
- name: Copying a PDSE V2 data set with all generations broadcom.file_master_plus.copy_data_set: from: fmmvs.from.psdsev2 to: fmmvs.to.psdsev2 generation: '*'
to: description: - Specifies the name of the data set to copy to. required: true type: str from: description: - Specifies the name of the data set to copy from. required: true type: str host: description: - Specifies File Master Plus server host name. required: false 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 members: description: - Specifies the members that you want to copy from the data set. To rename the member, specify a new member name after the delimiter ','.If this parameter is not specified all the members are copied. - 'Note: This parameter only applies to a PDS or PDSE.' - 'Example: mem1,newmem1 mem2. Here ''mem2'' is copied as it is, and ''mem1'' is renamed as ''newmem1''.' elements: str required: false type: list replace: default: true description: - 'Replace resource-specific items in the target data set. Note: Used only if the target data set is a PDS or a VSAM KSDS.' - 'Example: n.' required: false type: bool 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 generation: description: - Specifies the PDSE V2 generation number that you want to copy from the data set from. - 'Note: This parameter should only be specified if data set from is PDSEV2. If not specified and data set from is a PDSE V2 then current generation, i.e. generation 0, is copied. If generation is negative specifies Relative generation, positive specifies Absolute generation, * specifies all generations and 0 specifies current generation.' - 'Example1: *. All generations of member(s) is copied.' - 'Example2: -1. Relative generation -1 of member(s) is copied.' - 'Example3: 4. Absolute generation 4 of member(s) is copied.' - 'Allowed values: ''*'',''range from -2000000000 to 2000000000''.' required: false type: str cert_key_file: description: - The file path to a certificate key file to use for authentication. required: false type: path layout_member: description: - Specifies name of the Cobol or PL/I copybook. - 'Example: testlay.' required: false type: str layout_data_set: description: - Specifies name of the data set that contains the layout member. - 'Example: fmmvs.layout.dataset.' required: false type: str reject_unauthorized: default: true description: - Reject self-signed certificates. required: false type: bool static_selection_criteria: description: - Specifies the name of pre-defined File Master Plus selection criteria. The name refers to a member in the defaultselection criteria data set as defined in the FMM_CLIST parameter in File Master Plus server. - 'Example: testcri.' required: false type: str dynamic_selection_criteria: description: - Specifies path of the .txt file where the dynamic selection criteria exist. Ensure the format of the file is identical to the static selection criteria created by File Master Plus. If the selection criteria refer to field names in a Cobol or PL/I copybook, use the and parameters to name the copybook location. - 'Example: ../selcri/testcri.txt .' required: false type: str
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