rename_data_set – Rename a data set

Synopsis

Rename a data set.

It supports all data set types that are supported by File Master Plus.

Parameters

old (required, type: str)

Specifies the name of the data set that you want to rename.

new (required, type: str)

Specifies the new name of the data set.

vsam_component (type: bool)

Rename the data and index components of a VSAM cluster if they share the cluster name.

Note: Used only if the target data set is a VSAM cluster.

Example: y.

host (type: str)

Specifies File Master Plus server host name.

port (type: int, default: 51914)

Specifies File Master Plus server port.

user (type: str)

Specifies Mainframe user name. May be the same as TSO login.

password (type: str)

Specifies Mainframe password. May be the same as TSO password.

protocol (type: str, default: https)

Specifies File Master Plus REST API protocol.

Choices:

  • http

  • https ←

reject_unauthorized (type: bool, default: True)

Reject self-signed certificates.

base_path (type: str)

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.

cert_file (type: path)

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.

cert_key_file (type: path)

The file path to a certificate key file to use for authentication.

Examples

- name: Renaming a data set
  broadcom.file_master_plus.rename_data_set:
    old: fmmvs.old.dsname
    new: fmmvs.new.dsname

- name: Renaming a VSAM data set along with its components
  broadcom.file_master_plus.rename_data_set:
    old: fmmvs.oldvsam.dsname
    new: fmmvs.newvsam.dsname
    vsam_component: y

Return Values

data (type: list, when returned data is a dictionary)

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.

error (type: complex, error)

More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters.

additional_details (type: str)

Detailed message about the failure.

msg (type: str)

Short description of the result or failure.

request (type: str, API request failed)

HTTP method used to invoke API service request.

resource (type: str, API request failed)

URI of the resource of the API service request.

failed (type: bool, always)

A boolean that indicates if the task was failed or not.

list (type: list, when returned data is a list)

Data from the module execution (a list of data structures).

msg (type: str, sometimes)

Short description of the result or failure.

rc (type: int, always)

Exit code of the module, successful exit code is 0, failure is typically 1 or higher.

stderr (type: str, error)

Details of the error.

stdout (type: str, success)

Summary of the result.

Status

  • This module is maintained by Broadcom.