Skip to content

z/OS Management Facility - Roles

zOSMFService Role

Role for resources that represent zOSMF Service.

NameTypeDescription
zOS VersionStringThe z/OS operating system level. The Resource Role property name is zosmf.zos_version.
zOSMF API VersionStringThe version of the z/OSMF information retrieval service and the JSON object structure used for this request. The version sequence starts at 1, and is incremented if the service or the JSON structure changes. The Resource Role property name is zosmf.api_version.
zOSMF Full VersionStringThe z/OSMF version qualified by a service level. The Resource Role property name is zosmf.zosmf_full_version.
zOSMF HostnameStringThe hostname or the IP address of the z/OS system on which z/OSMF is installed. The Resource Role property name is zosmf.zosmf_hostname.
zOSMF PasswordPasswordThe zOSMF password associate with the specified user.
zOSMF PortStringThe port number for SSL encrypted traffic for the active instance of z/OSMF on the z/OS system. The Resource Role property name is zosmf.zosmf_port.
zOSMF QueryStringA list of one or more query variables. Check the z/OSMF List the software services instances REST API for a list of valid query parameters. The Resource Role property name is zosmf.query.
zOSMF SAF RealmStringThe realm associated with the system on which z/OSMF is installed. Usually, this is the sysplex name. The Resource Role property name is zosmf.zosmf_saf_realm.
zOSMF URLStringThe URL to access the zOSMF REST API. The Resource Role property name is zosmf.url.
zOSMF UserStringThe zOSMF user to use. The Resource Role property name is zosmf.user.
zOSMF VersionStringThe z/OSMF level. The Resource Role property name is zosmf.zosmf_version.

zOSMFSoftwareInstance Role

Role for resources that represent a software instance.

NameTypeDescription
Created ByStringThe user ID that created the object.
Created OnStringThe time the object was created. The time is in the ISO8601 format. The Resource Role property name is instance.created-time.
Domain NameStringThe name of the domain. The Resource Role property name is instance.domain-name.
External NameStringThe external name of the software services instance. The Resource Role property name is instance.external-name.
Last Action NameStringThe name of the last action that was performed. The Resource Role property name is instance.last-action-name.
Last Action StateStringThe state of the last action that was performed. The Resource Role property name is instance.last-action-state.
Object IDStringThe object ID for the software services instance. The Resource Role property name is instance.object-id.
Object NameStringThe object name for the software services instance. The Resource Role property name is instance.object-name.
StateStringThe current state of the software. The Resource Role property name is instance.state.
Tenant NameStringThe name of the tenant. The Resource Role property name is instance.tenant-name.
TypeStringThe type of software instance.