Warning: This document is for an old version of IBM z/OSMF Collection. The latest version is v3.0.0.

IBM z/OS Management Facility Collection

IBM z/OS Management Facility (z/OSMF) Collection, referred to as ibm_zos_zosmf, consists of modules and roles that you can use with z/OS.

IBM z/OSMF collection intends to allow Ansible to drive z/OS operation and configuration by manipulating z/OS resources and data based on z/OSMF RESTful services, such as z/OSMF workflow services, z/OS jobs REST services, z/OS console REST services, z/OS data set and file REST services, Cloud Provisioning and Management services etc.

Features

IBM z/OSMF collection includes modules, roles, sample playbooks and ansible-doc to automate tasks on z/OS.

Getting Started

• Installation
  • Ansible Galaxy
  • Local Build
• Quickstart
  • Access Collection
  • Contents
    • Operate z/OS Workflows
      • Modules
      • Roles
      • Requirements
      • Sample Playbooks
    • Provision and Manage z/OS Software Instances
      • Roles
      • Requirements
      • Sample Playbooks
    • Operate z/OS Jobs
      • Roles
      • Requirements
      • Sample Playbooks
    • Operate MVS Commands
      • Modules
      • Requirements
      • Sample Playbooks
    • Operate z/OS Data Sets and UNIX Files
      • Modules
      • Requirements
      • Sample Playbooks

References

• Modules
  • Module Reference
    • zmf_authenticate – Authenticate with z/OSMF server
    • zmf_console_command – Issue MVS command
    • zmf_dataset – Manage z/OS data set or member
    • zmf_dataset_copy – Copy data to z/OS data set or member
    • zmf_dataset_fetch – Fetch z/OS data set or member from z/OS
    • zmf_file – Manage z/OS USS file or directory
    • zmf_file_copy – Copy data to z/OS USS file
    • zmf_file_fetch – Fetch USS file from z/OS
    • zmf_workflow – Operate z/OS workflows
  • Module Documentation
• Roles
  • Role Reference
    • zmf_workflow_complete
    • zmf_cpm_provision_software_service
    • zmf_cpm_manage_software_instance
    • zmf_cpm_remove_software_instance
    • zmf_job_complete
    • zmf_job_query
• Playbooks
  • Playbook Documentation
  • Ansible Config
  • Inventory
  • Host Vars
  • Group Vars
  • Sample Playbooks
    • sample_module_console_command
    • sample_module_dataset
    • sample_module_dataset_copy
    • sample_module_dataset_fetch
    • sample_module_file
    • sample_module_file_copy
    • sample_module_file_fetch
    • sample_module_workflow
    • sample_role_cpm_manage_instance
    • sample_role_cpm_provision
    • sample_role_cpm_remove_instance
    • sample_role_deploy_cics_application
    • sample_role_job_complete
    • sample_role_job_query
    • sample_role_workflow_complete
  • Run the Playbooks

Community Guides

• Contributing
• Helpful Links

Requirements

• Requirements
  • Overall Requirements
  • Specific Requirements
    • Requirements - Operate z/OS Workflows
    • Requirements - Provision and Manage z/OS Software Instances
    • Requirements - Operate z/OS Jobs
    • Requirements - Operate MVS Commands
    • Requirements - Operate z/OS Data Sets and UNIX Files

Appendices

• Releases

Copyright

© Copyright IBM Corporation 2020

License

Some portions of this collection are licensed under GNU General Public License, Version 3.0, and other portions of this collection are licensed under Apache License, Version 2.0. See individual files for applicable licenses.

Author Information

IBM z/OSMF collection is maintained by the IBM z/OSMF development team. For more information about z/OSMF， see IBM z/OSMF One Stop Hub.