broadcom.file_master_plus.create_partitioned_data_set (5.0.9) — module

Create a partitioned 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 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

Create a partitioned data set.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Creating a PDS with default option values
  broadcom.file_master_plus.create_partitioned_data_set:
    name: fmmvs.test.dsname
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Creating a PDS with options
  broadcom.file_master_plus.create_partitioned_data_set:
    name: fmmvs.test.dsname
    logical_record_length: 180
    block_size: 32720
    record_format: vb
    space_units: trk
    primary_space: 5
    secondary_space: 5
    directory_blocks: 5
    volume: vol005
    expiration_date: p
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Creating a PDS like a model PDS
  broadcom.file_master_plus.create_partitioned_data_set:
    name: fmmvs.test.dsname
    model: fmmvs.model.dsname
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Creating a PDS like a model PDS and overriding the parameters with options
  broadcom.file_master_plus.create_partitioned_data_set:
    name: fmmvs.test.dsname
    model: fmmvs.model.dsname
    logical_record_length: 180
    record_format: vb
    primary_space: 5
    secondary_space: 5
    directory_blocks: 5
    volume: vol005
    expiration_date: 2025-09-27

Inputs

    
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

model:
    description:
    - Specifies the name of a model partitioned data set for allocating parameters.
    - The parameters of the model data set override all defaults.
    - 'Example: fmmvs.model.dsname.'
    required: false
    type: str

volume:
    description:
    - Specifies a disk volume or specific tapes.
    - 'Example: vol002.'
    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

unit_type:
    description:
    - Specifies the DASD unit name.
    - 'Example: sysda.'
    required: false
    type: str

block_size:
    description:
    - Specifies the size of the block of records.
    - 'Allowed values: 1-32760'
    - 'Default value: 6160'
    - 'Example: 6160'
    required: false
    type: int

data_class:
    description:
    - Specifies the data class.
    - 'Example: dcl002.'
    required: false
    type: str

space_units:
    choices:
    - TRK
    - CYL
    - BLK
    description:
    - Specifies the space allocation unit.
    - 'The allowed values which have the following meaning: '
    - TRK - Tracks
    - CYL - Cylinders
    - BLK - Blocksize
    - 'Default value: CYL'
    - 'Example: blk'
    required: false
    type: str

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

primary_space:
    description:
    - Specifies the primary space allocation unit.
    - 'Allowed values: 1-16777215'
    - 'Default value: 1'
    - 'Example: 3'
    required: false
    type: int

record_format:
    choices:
    - F
    - FA
    - FM
    - FB
    - FBA
    - FBM
    - FS
    - FSA
    - FSM
    - FT
    - FTA
    - FTM
    - FBS
    - FBT
    - U
    - UA
    - UM
    - UT
    - UTA
    - UTM
    - V
    - VA
    - VM
    - VB
    - VBA
    - VBM
    - VS
    - VSA
    - VSM
    - VT
    - VTA
    - VTM
    - VBS
    - VBT
    description:
    - Specifies the record format.
    - 'The allowed values have the following meaning:'
    - F - Fixed-length records
    - V - Variable-length records
    - U - Undefined-length records
    - B - Records are blocked
    - A - Records contain ASCII printer control characters
    - M - Records contain machine code control characters
    - S - For variable-length records, records may span blocks
    - T - Records may be written into overflow tracks
    - 'Default value: FB'
    - 'Example: FB'
    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

secondary_space:
    description:
    - Specifies the secondary space allocation unit.
    - 'Allowed values: 1-16777215'
    - 'Default value: 1'
    - 'Example: 5'
    required: false
    type: int

directory_blocks:
    description:
    - Specifies number of directory blocks.
    - 'Allowed values: 1-16777215'
    - 'Default value: 5'
    - 'Example: 5'
    required: false
    type: int

management_class:
    description:
    - Specifies the management class.
    - 'Example: mcl002.'
    required: false
    type: str

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

logical_record_length:
    description:
    - Specifies the length of the logical record.
    - 'Allowed values: 1-32760'
    - 'Default value: 80'
    - 'Example: 80'
    required: false
    type: int

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