Try SpotterCreate an ESDS VSAM 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.
Install with ansible-galaxy collection install broadcom.file_master_plus:==5.0.9
collections:
- name: broadcom.file_master_plus
version: 5.0.9Create an entry-sequenced Virtual Storage Access Method (VSAM) data set (ESDS).
- name: Creating a ESDS with default option values and mandatory options
broadcom.file_master_plus.create_vsam_esds:
name: fmmvs.test.dsname
maximum_record_size: 160
- name: Creating a ESDS with options
broadcom.file_master_plus.create_vsam_esds:
name: fmmvs.test.dsname
maximum_record_size: 160
average_record_size: 120
data_control_interval_size: 3584
data_space_units: cyl
data_primary_space: 1
data_secondary_space: 3
data_volume:
- "vol002"
buffer_space: 37376
erase: y
reuse: y
spanned: n
expiration_date: 2025-09-27
- name: Creating a RLS enabled ESDS with logging options
broadcom.file_master_plus.create_vsam_esds:
name: fmmvs.test.dsname
maximum_record_size: 160
average_record_size: 120
data_control_interval_size: 3584
data_space_units: cyl
data_primary_space: 1
data_secondary_space: 3
data_volume:
- "vol002"
buffer_space: 37376
erase: y
reuse: y
spanned: n
log: all
frlog: ALL
log_replicate: y
log_stream_id: loga
rls_enable: y
- name: Creating a ESDS data set like a model ESDS data set
broadcom.file_master_plus.create_vsam_esds:
name: fmmvs.test.dsname
model: fmmvs.model.dsname
- name: Creating a ESDS like a model ESDS data set and overriding the parameters with options
broadcom.file_master_plus.create_vsam_esds:
name: fmmvs.test.dsname
model: fmmvs.model.dsname
maximum_record_size: 160
buffer_space: 37376
write_check: y
cross_region_share_option: 3
cross_system_share_option: 4
expiration_date: p
log:
choices:
- NONE
- UNDO
- ALL
description:
- When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
- 'Example: ALL.'
required: false
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 create.
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
erase:
description:
- Indicates whether the VSAM file was allocated with the ERASE parameter, causing
all components of the file to be overwritten with binary zeros, when the VSAM file
is deleted from the catalog.
- 'Default value: n'
- 'Example: y'
required: false
type: bool
frlog:
choices:
- NONE
- UNDO
- ALL
- REDO
description:
- Specifies the type of VSAM batch logging to perform for this VSAM data set.
- 'The allowed values have the following meaning:'
- NONE - Disables VSAM batch logging.
- REDO - Enables VSAM batch logging.
- UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
- ALL - Changes made to your VSAM data set are backed out and forward recovered using
VSAM batch logging.
- 'Example: ALL.'
required: false
type: str
model:
description:
- Specifies the name of a ESDS (entry-sequenced VSAM data set) for allocating parameters.
- The parameters of the model data set override all defaults.
- 'Example: fmmvs.model.dsname.'
required: false
type: str
reuse:
description:
- Indicates whether the VSAM file was allocated with the REUSE parameter specifying
that the cluster can be opened again and again as a reusable cluster.
- 'Default value: n'
- 'Example: y'
required: false
type: bool
spanned:
description:
- Indicates whether VSAM file was allocated with the SPANNED parameter indicating
that data records larger than a control interval can span multiple control intervals.
- 'Default value: n'
- 'Example: y'
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
data_class:
description:
- Specifies the data class.
- 'Example: dcl002.'
required: false
type: str
rls_enable:
description:
- Specify 'N' to disable VSAM record-level sharing.
- 'Default value: y'
- 'Example: n'
required: false
type: bool
data_dsname:
description:
- Specifies the data set name of the data VSAM component.
- "If this parameter is not specified then by default it is set to the cluster name\
\ with \u2018.DATA\u2019."
- 'Example: fmmvs.vsam.esds.data.'
required: false
type: str
data_volume:
description:
- Specifies a disk volume or specific tapes for the data VSAM component.
- 'Example: vol002.'
elements: str
required: false
type: list
write_check:
description:
- Indicates whether the VSAM file was allocated with the WRITECHECK parameter requesting
each write to the VSAM file to be validated by a read without data transfer.
- 'Default value: n'
- 'Example: y'
required: false
type: bool
buffer_space:
description:
- Specifies the minimum buffer space to allocate when this VSAM file is accessed.
- 'Example: 37376.'
required: false
type: int
cert_key_file:
description:
- The file path to a certificate key file to use for authentication.
required: false
type: path
log_replicate:
description:
- Specify 'Y' to enable VSAM replication for this data set.
- 'Example: y.'
required: false
type: bool
log_stream_id:
description:
- Specifies the 1- to 26-character name of the forward recovery log stream.
- 'Example: LOGSTRA.'
required: false
type: str
storage_class:
description:
- Specifies the storage class.
- 'Example: scl002.'
required: false
type: str
expiration_date:
description:
- Specifies the expiration date after which the data set can be deleted.
- Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD
format.
- 'Example: 2032-07-31.'
required: false
type: str
data_space_units:
choices:
- TRK
- CYL
- REC
- K
- M
description:
- Specifies the space allocation unit for data vsam component.
- 'The allowed values have the following meaning: '
- TRK - Tracks
- CYL - Cylinders
- REC - Records
- K - Kilobytes
- M - Megabytes
- 'Default value: TRK'
- 'Example: rec'
required: false
type: str
load_restartable:
description:
- Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter
(which causes the data component to be preformatted previous to the initial load).
Using this option causes the initial load to take longer, but loads which do not
complete successfully can be restarted.
- Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter
(which causes the data component to NOT be preformatted previous to the initial
load).
- 'Default value: n'
- 'Example: y'
required: false
type: bool
management_class:
description:
- Specifies the management class.
- 'Example: mcl002.'
required: false
type: str
data_primary_space:
description:
- Specifies the primary space allocation unit for the data VSAM component.
- 'Allowed values: 1-16777215'
- 'Default value: 18'
- 'Example: 3'
required: false
type: int
average_record_size:
description:
- Specifies the average length of data records.
- If this parameter is not specified then it is set to the same as the maximum-record-size
option.
- 'Example: 110.'
required: false
type: int
maximum_record_size:
description:
- Specifies the maximum length of data records.
- This parameter is mandatory unless a model data set is specified.
- 'Example: 180.'
required: false
type: int
reject_unauthorized:
default: true
description:
- Reject self-signed certificates.
required: false
type: bool
data_secondary_space:
description:
- Specifies the secondary space allocation unit for the data VSAM component.
- 'Allowed values: 1-16777215'
- 'Default value: 3'
- 'Example: 5'
required: false
type: int
cross_region_share_option:
choices:
- '1'
- '2'
- '3'
- '4'
description:
- Specifies that the file can be shared among regions within the same system or within
multiple systems using GRS (Global Resource Serialization).
- 'The allowed values have the following meaning:'
- 1 - The data set can be opened for read processing by an unlimited number of users,
but the data set can be accessed by only one user when that user is doing read and
write processing.
- 2 - The data set can be opened by only one user at a time for read and write processing,
but any number of users can also be accessing the data set for read processing
- 3 - The data set can be fully shared by any number of users.
- 4 - The data set can be fully shared by any number of users. VSAM immediately updates
the data set for PUTs and refreshes all input buffers for GETs.
- 'Default value: 1'
- 'Example: 2'
required: false
type: int
cross_system_share_option:
choices:
- '3'
- '4'
description:
- Specifies how the file can be shared among systems.
- 'The allowed values have the following meaning: '
- 3 - The data set can be fully shared by any number of users.
- 4 - The data set can be fully shared by any number of users. VSAM immediately updates
the data set for PUTs and refreshes all input buffers for GETs.
- 'Default value: 3'
- 'Example: 4'
required: false
type: int
data_control_interval_size:
description:
- Specifies the size of the Control Interval for the data VSAM component.
- 'Default value: 20480'
- 'Example: 3584'
required: false
type: int
control_area_freespace_percentage:
description:
- Specifies the percentage of control intervals to be left unused in each control
area as the file is initially loaded. The use of control area free space lets some
control interval splits occur before requiring a control area split.
- 'Example: 10.'
required: false
type: int
control_interval_freespace_percentage:
description:
- Specifies the percentage of empty space in each control interval when the file is
initially loaded.The free space lets records be inserted or expanded within a control
interval before requiring a control interval split.
- 'Example: 10.'
required: false
type: int
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