List RACF Options

Extract the system’s RACF Options.

SetroptsAdmin.list_racf_options()

def list_racf_options(self,  options_only: bool = False) -> Union[dict, bytes]:

📄 Description

 

SetroptsAdmin.list_racf_options() is more or less fully functional but still needs additional testing and validation, which may lead to significant changes in the structure of extracted RACF Options data.

 

List the system’s RACF Options

📥 Parameters

  • options_only
    When set to True, only the racf options will be returned instead of returning the entire Security Result dictionary.

📤 Returns

  • Union[dict, bytes]
    Returns a Security Result dictionary or Security Request XML bytes if the SetroptsAdmin.generate_requests_only class attribute is set to True.

❌ Raises

  • SecurityRequestError
    Raises SecurityRequestError when the SAF Return Code of a Security Result is equal to 4.
  • DownstreamFatalError
    Raises DownstreamFatalError when the SAF Return Code of a Security Result is greater than 4.

💻 Example

The following example lists racf options on the system.

Python REPL
>>> from pyracf import SetroptsAdmin
>>> setropts_admin = SetroptsAdmin()
>>> setropts_admin.list_racf_options()
{"securityResult":{"systemSettings":{"operation":"set","requestId":"SetroptsRequest","commands":[{"safReturnCode":0,"returnCode":0,"reasonCode":0,"image":"SETROPTS   LIST","profiles":[{"attributes":{"initializationStatistics":true,"programControl":"basic","terminalAccess":"read"},"classes":{"statistics":[],"active":["dataset","user","group","acctnum","aceechk","acicspct","aims","alcsauth","appclu","appcport","appcsi","appl","bcicspct","cachecls","cbind","ccicscmd","cdt","cfield","cims","command","cpsmobj","cpsmxmp","cryptoz","csfkeys","csfserv","dasdvol","dasnames","dbnform","dceuuids","dcicsdct","devices","digtcert","digtcrit","digtnmap","digtring","dims","dlfclass","dsnadm","dsnr","ecicsdct","ejbrole","elijtest","facility","fcicsfct","field","fims","fsaccess","fsexec","gcicstrn","gcpsmobj","gcsfkeys","gdasdvol","gdsnbp","gdsncl","gdsndb","gdsngv","gdsnjr","gdsnpk","gdsnpn","gdsnsc","gdsnsg","gdsnsm","gdsnsp","gdsnsq","gdsntb","gdsnts","gdsnuf","gdsnut","gejbrole","gims","ginfoman","global","gmbr","gmqadmin","gmqnlist","gmqproc","gmqqueue","gsdsf","gsomdobj","gterminl","gxcsfkey","gxfacili","gzmfapla","hbradmin","hbrcmd","hbrconn","hcicsfct","hims","ibmopc","ididmap","idtdata","iims","ilmadmin","infoman","java","jcicsjct","jesspool","jims","kcicsjct","kerblink","ldap","ldapbind","lfsclass","lims","logstrm","mcicsppt","mdsnbp","mdsncl","mdsndb","mdsngv","mdsnjr","mdsnpk","mdsnpn","mdsnsc","mdsnsg","mdsnsm","mdsnsp","mdsnsq","mdsntb","mdsnts","mdsnuf","mdsnut","mfadef","mgmtclas","mims","mqadmin","mqcmds","mqconn","mqnlist","mqproc","mqqueue","ncicsppt","ndslink","netcmds","netspan","nodes","nodmbr","notelink","nvasapdt","oims","omcandl$","opercmds","pcicspsb","perfgrp","pims","pkiserv","pmbr","printsrv","program","propcntl","ptktdata","ptktval","qcicspsb","qims","racfevnt","racfvars","racglist","rauditx","rcicsres","rdatalib","realm","rims","rmtops","rodmmgr","rrsfdata","rvarsmbr","scdmbr","scicstst","sdsf","secdata","servauth","server","sims","smessage","somdobjs","started","storclas","subsysnm","surrogat","sysauto","sysmview","tapevol","tcicstrn","terminal","tims","tsoauth","tsoproc","ucicstst","uims","unixmap","unixpriv","vcicscmd","vmbatch","vmbr","vmcmd","vmdev","vmevent","vmlan","vmmdisk","vmnode","vmposix","vmrdr","vmsegmt","vmxevent","vtamappl","vxmbr","wbem","wcicsres","wims","xcsfkey","xfacilit","zmfapla","zmfcloud"],"genericProfile":["dataset","acctnum","acicspct","aims","appclu","appcport","appcserv","appcsi","appctp","appl","cbind","ccicscmd","cims","command","console","cpsmobj","cpsmxmp","csfkeys","csfserv","dasdvol","dasnames","dbnform","dcicsdct","devices","diracc","dirauth","dirsrch","dlfclass","dsnr","ejbrole","facility","fcicsfct","field","fims","fsobj","fssec","gmbr","ibmopc","infoman","jcicsjct","jesinput","jesjobs","jesspool","ldap","lfsclass","logstrm","mcicsppt","mgmtclas","mqadmin","mqchan","mqcmds","mqconn","mqnlist","mqproc","mqqueue","netcmds","netspan","nodes","nodmbr","nvasapdt","oims","omcandl$","opercmds","pcicspsb","perfgrp","pims","pmbr","procact","process","propcntl","psfmpl","ptktdata","ptktval","racfvars","racglist","rcicsres","rmtops","rodmmgr","rvarsmbr","scdmbr","scicstst","sdsf","seclmbr","servauth","server","sims","smessage","somdobjs","started","storclas","subsysnm","surrogat","tapevol","tcicstrn","tempdsn","terminal","tims","tsoauth","tsoproc","unixpriv","vmbatch","vmbr","vmcmd","vmmac","vmmdisk","vmnode","vmrdr","vmsegmt","vtamappl","vxmbr","writer","xcsfkey","xfacilit","zmfapla","zmfcloud"],"genericCommand":["dataset","acctnum","acicspct","aims","appclu","appcport","appcserv","appcsi","appctp","appl","cbind","ccicscmd","cims","command","console","cpsmobj","cpsmxmp","csfkeys","csfserv","dasdvol","dasnames","dbnform","dcicsdct","devices","diracc","dirauth","dirsrch","dlfclass","dsnr","ejbrole","facility","fcicsfct","field","fims","fsobj","fssec","gmbr","ibmopc","infoman","jcicsjct","jesinput","jesjobs","jesspool","ldap","lfsclass","logstrm","mcicsppt","mgmtclas","mqadmin","mqchan","mqcmds","mqconn","mqnlist","mqproc","mqqueue","netcmds","netspan","nodes","nodmbr","nvasapdt","oims","omcandl$","opercmds","pcicspsb","perfgrp","pims","pmbr","procact","process","propcntl","psfmpl","ptktdata","ptktval","racfvars","racglist","rcicsres","rmtops","rodmmgr","rvarsmbr","scdmbr","scicstst","sdsf","seclmbr","servauth","server","sims","smessage","somdobjs","started","storclas","subsysnm","surrogat","tapevol","tcicstrn","tempdsn","terminal","tims","tsoauth","tsoproc","unixpriv","vmbatch","vmbr","vmcmd","vmmac","vmmdisk","vmnode","vmrdr","vmsegmt","vtamappl","vxmbr","writer","xcsfkey","xfacilit","zmfapla","zmfcloud"],"genericProfileSharing":[],"globalChecking":["dataset","dsnr","sdsf","surrogat"],"raclist":["acctnum","aceechk","appl","cbind","cdt","cpsmobj","cryptoz","csfkeys","csfserv","digtcert","digtcrit","digtnmap","digtring","dsnr","ejbrole","elijtest","facility","jesspool","opercmds","perfgrp","ptktdata","ptktval","racfvars","rdatalib","realm","sdsf","servauth","server","somdobjs","started","surrogat","tsoauth","tsoproc","unixpriv","wbem","xcsfkey","xfacilit","zmfapla","zmfcloud"],"globalRaclistOnly":["vtamappl"]},"dataSets":{"automaticProtection":false,"enhancedGenericNaming":true,"realNamesLogging":false,"protectAll":false,"tapeProtection":true,"securityRetentionPeriod":0,"eraseOnScratch":{"enabled":false,"options":{}},"singleLevelNamePrefix":null,"generationDataGroupModelling":true,"userModelling":true,"groupModelling":true,"cataloguedAccessOnly":{"enabled":false,"options":{}},"addCreator":true},"jes":{"batchAll":true,"executionBatchMonitorAll":false,"earlyVerify":false,"networkUser":"????????","undefinedUser":"++++++++"},"groupRules":{"listOfGroupsAccessChecking":true},"revokeUserids":{"revokeAfter":255},"passwordProcessingOptions":{"activePasswordEncryptionAlgorithm":"legacy","passwordChangeInterval":186,"passwordMinimumChangeInterval":0,"mixedCasePasswordSupport":false,"specialCharactersAllowed":false,"passwordHistoryGenerations":0,"maxUnsuccessfulPasswordAttempts":null,"passwordExpirationWarningLevel":10,"syntaxRules":{"rules":[{"minLength":4,"maxLength":8,"content":"********"}],"legend":{"A":"alpha","C":"consonant","L":"alphanumeric","N":"numeric","V":"vowel","W":"no vowel","*":"anything","c":"mixed consonant","m":"mixed numeric","v":"mixed vowel","$":"national","s":"special","x":"mixed all"}}},"defaultRvaryPassword":["switch","status"],"securityLabels":{"allowControlForReadAccess":false,"compatibilityMode":false,"bySystem":false},"genericRules":{"restrictGenericOwner":false},"multiLevelSecurity":{"quiet":false,"stable":false,"noWriteDown":{"enabled":false,"options":{}},"active":{"enabled":false,"options":{}},"fileSystem":false,"interprocessCommunications":false,"nameHiding":false},"appc":{"maxSessionKeyInterval":30},"kerberos":{"encryptionLevel":0},"languageDefaults":{"primary":"enu","secondary":"enu"}}]}]},"returnCode":0,"reasonCode":0}}
Security Result Dictionary as JSON
{
  "securityResult": {
    "systemSettings": {
      "operation": "set",
      "requestId": "SetroptsRequest",
      "commands": [
        {
          "safReturnCode": 0,
          "returnCode": 0,
          "reasonCode": 0,
          "image": "SETROPTS   LIST",
          "profiles": [
            {
              "attributes": {
                "initializationStatistics": true,
                "programControl": "basic",
                "terminalAccess": "read"
              },
              "classes": {
                "statistics": [],
                "active": [
                  "dataset",
                  "user",
                  "group",
                  "acctnum",
                  "aceechk",
                  "acicspct",
                  "aims",
                  "alcsauth",
                  "appclu",
                  "appcport",
                  "appcsi",
                  "appl",
                  "bcicspct",
                  "cachecls",
                  "cbind",
                  "ccicscmd",
                  "cdt",
                  "cfield",
                  "cims",
                  "command",
                  "cpsmobj",
                  "cpsmxmp",
                  "cryptoz",
                  "csfkeys",
                  "csfserv",
                  "dasdvol",
                  "dasnames",
                  "dbnform",
                  "dceuuids",
                  "dcicsdct",
                  "devices",
                  "digtcert",
                  "digtcrit",
                  "digtnmap",
                  "digtring",
                  "dims",
                  "dlfclass",
                  "dsnadm",
                  "dsnr",
                  "ecicsdct",
                  "ejbrole",
                  "elijtest",
                  "facility",
                  "fcicsfct",
                  "field",
                  "fims",
                  "fsaccess",
                  "fsexec",
                  "gcicstrn",
                  "gcpsmobj",
                  "gcsfkeys",
                  "gdasdvol",
                  "gdsnbp",
                  "gdsncl",
                  "gdsndb",
                  "gdsngv",
                  "gdsnjr",
                  "gdsnpk",
                  "gdsnpn",
                  "gdsnsc",
                  "gdsnsg",
                  "gdsnsm",
                  "gdsnsp",
                  "gdsnsq",
                  "gdsntb",
                  "gdsnts",
                  "gdsnuf",
                  "gdsnut",
                  "gejbrole",
                  "gims",
                  "ginfoman",
                  "global",
                  "gmbr",
                  "gmqadmin",
                  "gmqnlist",
                  "gmqproc",
                  "gmqqueue",
                  "gsdsf",
                  "gsomdobj",
                  "gterminl",
                  "gxcsfkey",
                  "gxfacili",
                  "gzmfapla",
                  "hbradmin",
                  "hbrcmd",
                  "hbrconn",
                  "hcicsfct",
                  "hims",
                  "ibmopc",
                  "ididmap",
                  "idtdata",
                  "iims",
                  "ilmadmin",
                  "infoman",
                  "java",
                  "jcicsjct",
                  "jesspool",
                  "jims",
                  "kcicsjct",
                  "kerblink",
                  "ldap",
                  "ldapbind",
                  "lfsclass",
                  "lims",
                  "logstrm",
                  "mcicsppt",
                  "mdsnbp",
                  "mdsncl",
                  "mdsndb",
                  "mdsngv",
                  "mdsnjr",
                  "mdsnpk",
                  "mdsnpn",
                  "mdsnsc",
                  "mdsnsg",
                  "mdsnsm",
                  "mdsnsp",
                  "mdsnsq",
                  "mdsntb",
                  "mdsnts",
                  "mdsnuf",
                  "mdsnut",
                  "mfadef",
                  "mgmtclas",
                  "mims",
                  "mqadmin",
                  "mqcmds",
                  "mqconn",
                  "mqnlist",
                  "mqproc",
                  "mqqueue",
                  "ncicsppt",
                  "ndslink",
                  "netcmds",
                  "netspan",
                  "nodes",
                  "nodmbr",
                  "notelink",
                  "nvasapdt",
                  "oims",
                  "omcandl$",
                  "opercmds",
                  "pcicspsb",
                  "perfgrp",
                  "pims",
                  "pkiserv",
                  "pmbr",
                  "printsrv",
                  "program",
                  "propcntl",
                  "ptktdata",
                  "ptktval",
                  "qcicspsb",
                  "qims",
                  "racfevnt",
                  "racfvars",
                  "racglist",
                  "rauditx",
                  "rcicsres",
                  "rdatalib",
                  "realm",
                  "rims",
                  "rmtops",
                  "rodmmgr",
                  "rrsfdata",
                  "rvarsmbr",
                  "scdmbr",
                  "scicstst",
                  "sdsf",
                  "secdata",
                  "servauth",
                  "server",
                  "sims",
                  "smessage",
                  "somdobjs",
                  "started",
                  "storclas",
                  "subsysnm",
                  "surrogat",
                  "sysauto",
                  "sysmview",
                  "tapevol",
                  "tcicstrn",
                  "terminal",
                  "tims",
                  "tsoauth",
                  "tsoproc",
                  "ucicstst",
                  "uims",
                  "unixmap",
                  "unixpriv",
                  "vcicscmd",
                  "vmbatch",
                  "vmbr",
                  "vmcmd",
                  "vmdev",
                  "vmevent",
                  "vmlan",
                  "vmmdisk",
                  "vmnode",
                  "vmposix",
                  "vmrdr",
                  "vmsegmt",
                  "vmxevent",
                  "vtamappl",
                  "vxmbr",
                  "wbem",
                  "wcicsres",
                  "wims",
                  "xcsfkey",
                  "xfacilit",
                  "zmfapla",
                  "zmfcloud"
                ],
                "genericProfile": [
                  "dataset",
                  "acctnum",
                  "acicspct",
                  "aims",
                  "appclu",
                  "appcport",
                  "appcserv",
                  "appcsi",
                  "appctp",
                  "appl",
                  "cbind",
                  "ccicscmd",
                  "cims",
                  "command",
                  "console",
                  "cpsmobj",
                  "cpsmxmp",
                  "csfkeys",
                  "csfserv",
                  "dasdvol",
                  "dasnames",
                  "dbnform",
                  "dcicsdct",
                  "devices",
                  "diracc",
                  "dirauth",
                  "dirsrch",
                  "dlfclass",
                  "dsnr",
                  "ejbrole",
                  "facility",
                  "fcicsfct",
                  "field",
                  "fims",
                  "fsobj",
                  "fssec",
                  "gmbr",
                  "ibmopc",
                  "infoman",
                  "jcicsjct",
                  "jesinput",
                  "jesjobs",
                  "jesspool",
                  "ldap",
                  "lfsclass",
                  "logstrm",
                  "mcicsppt",
                  "mgmtclas",
                  "mqadmin",
                  "mqchan",
                  "mqcmds",
                  "mqconn",
                  "mqnlist",
                  "mqproc",
                  "mqqueue",
                  "netcmds",
                  "netspan",
                  "nodes",
                  "nodmbr",
                  "nvasapdt",
                  "oims",
                  "omcandl$",
                  "opercmds",
                  "pcicspsb",
                  "perfgrp",
                  "pims",
                  "pmbr",
                  "procact",
                  "process",
                  "propcntl",
                  "psfmpl",
                  "ptktdata",
                  "ptktval",
                  "racfvars",
                  "racglist",
                  "rcicsres",
                  "rmtops",
                  "rodmmgr",
                  "rvarsmbr",
                  "scdmbr",
                  "scicstst",
                  "sdsf",
                  "seclmbr",
                  "servauth",
                  "server",
                  "sims",
                  "smessage",
                  "somdobjs",
                  "started",
                  "storclas",
                  "subsysnm",
                  "surrogat",
                  "tapevol",
                  "tcicstrn",
                  "tempdsn",
                  "terminal",
                  "tims",
                  "tsoauth",
                  "tsoproc",
                  "unixpriv",
                  "vmbatch",
                  "vmbr",
                  "vmcmd",
                  "vmmac",
                  "vmmdisk",
                  "vmnode",
                  "vmrdr",
                  "vmsegmt",
                  "vtamappl",
                  "vxmbr",
                  "writer",
                  "xcsfkey",
                  "xfacilit",
                  "zmfapla",
                  "zmfcloud"
                ],
                "genericCommand": [
                  "dataset",
                  "acctnum",
                  "acicspct",
                  "aims",
                  "appclu",
                  "appcport",
                  "appcserv",
                  "appcsi",
                  "appctp",
                  "appl",
                  "cbind",
                  "ccicscmd",
                  "cims",
                  "command",
                  "console",
                  "cpsmobj",
                  "cpsmxmp",
                  "csfkeys",
                  "csfserv",
                  "dasdvol",
                  "dasnames",
                  "dbnform",
                  "dcicsdct",
                  "devices",
                  "diracc",
                  "dirauth",
                  "dirsrch",
                  "dlfclass",
                  "dsnr",
                  "ejbrole",
                  "facility",
                  "fcicsfct",
                  "field",
                  "fims",
                  "fsobj",
                  "fssec",
                  "gmbr",
                  "ibmopc",
                  "infoman",
                  "jcicsjct",
                  "jesinput",
                  "jesjobs",
                  "jesspool",
                  "ldap",
                  "lfsclass",
                  "logstrm",
                  "mcicsppt",
                  "mgmtclas",
                  "mqadmin",
                  "mqchan",
                  "mqcmds",
                  "mqconn",
                  "mqnlist",
                  "mqproc",
                  "mqqueue",
                  "netcmds",
                  "netspan",
                  "nodes",
                  "nodmbr",
                  "nvasapdt",
                  "oims",
                  "omcandl$",
                  "opercmds",
                  "pcicspsb",
                  "perfgrp",
                  "pims",
                  "pmbr",
                  "procact",
                  "process",
                  "propcntl",
                  "psfmpl",
                  "ptktdata",
                  "ptktval",
                  "racfvars",
                  "racglist",
                  "rcicsres",
                  "rmtops",
                  "rodmmgr",
                  "rvarsmbr",
                  "scdmbr",
                  "scicstst",
                  "sdsf",
                  "seclmbr",
                  "servauth",
                  "server",
                  "sims",
                  "smessage",
                  "somdobjs",
                  "started",
                  "storclas",
                  "subsysnm",
                  "surrogat",
                  "tapevol",
                  "tcicstrn",
                  "tempdsn",
                  "terminal",
                  "tims",
                  "tsoauth",
                  "tsoproc",
                  "unixpriv",
                  "vmbatch",
                  "vmbr",
                  "vmcmd",
                  "vmmac",
                  "vmmdisk",
                  "vmnode",
                  "vmrdr",
                  "vmsegmt",
                  "vtamappl",
                  "vxmbr",
                  "writer",
                  "xcsfkey",
                  "xfacilit",
                  "zmfapla",
                  "zmfcloud"
                ],
                "genericProfileSharing": [],
                "globalChecking": [
                  "dataset",
                  "dsnr",
                  "sdsf",
                  "surrogat"
                ],
                "raclist": [
                  "acctnum",
                  "aceechk",
                  "appl",
                  "cbind",
                  "cdt",
                  "cpsmobj",
                  "cryptoz",
                  "csfkeys",
                  "csfserv",
                  "digtcert",
                  "digtcrit",
                  "digtnmap",
                  "digtring",
                  "dsnr",
                  "ejbrole",
                  "elijtest",
                  "facility",
                  "jesspool",
                  "opercmds",
                  "perfgrp",
                  "ptktdata",
                  "ptktval",
                  "racfvars",
                  "rdatalib",
                  "realm",
                  "sdsf",
                  "servauth",
                  "server",
                  "somdobjs",
                  "started",
                  "surrogat",
                  "tsoauth",
                  "tsoproc",
                  "unixpriv",
                  "wbem",
                  "xcsfkey",
                  "xfacilit",
                  "zmfapla",
                  "zmfcloud"
                ],
                "globalRaclistOnly": [
                  "vtamappl"
                ]
              },
              "dataSets": {
                "automaticProtection": false,
                "enhancedGenericNaming": true,
                "realNamesLogging": false,
                "protectAll": false,
                "tapeProtection": true,
                "securityRetentionPeriod": 0,
                "eraseOnScratch": {
                  "enabled": false,
                  "options": {}
                },
                "singleLevelNamePrefix": null,
                "generationDataGroupModelling": true,
                "userModelling": true,
                "groupModelling": true,
                "cataloguedAccessOnly": {
                  "enabled": false,
                  "options": {}
                },
                "addCreator": true
              },
              "jes": {
                "batchAll": true,
                "executionBatchMonitorAll": false,
                "earlyVerify": false,
                "networkUser": "????????",
                "undefinedUser": "++++++++"
              },
              "groupRules": {
                "listOfGroupsAccessChecking": true
              },
              "revokeUserids": {
                "revokeAfter": 255
              },
              "passwordProcessingOptions": {
                "activePasswordEncryptionAlgorithm": "legacy",
                "passwordChangeInterval": 186,
                "passwordMinimumChangeInterval": 0,
                "mixedCasePasswordSupport": false,
                "specialCharactersAllowed": false,
                "passwordHistoryGenerations": 0,
                "maxUnsuccessfulPasswordAttempts": null,
                "passwordExpirationWarningLevel": 10,
                "syntaxRules": {
                  "rules": [
                    {
                      "minLength": 4,
                      "maxLength": 8,
                      "content": "********"
                    }
                  ],
                  "legend": {
                    "A": "alpha",
                    "C": "consonant",
                    "L": "alphanumeric",
                    "N": "numeric",
                    "V": "vowel",
                    "W": "no vowel",
                    "*": "anything",
                    "c": "mixed consonant",
                    "m": "mixed numeric",
                    "v": "mixed vowel",
                    "$": "national",
                    "s": "special",
                    "x": "mixed all"
                  }
                }
              },
              "defaultRvaryPassword": [
                "switch",
                "status"
              ],
              "securityLabels": {
                "allowControlForReadAccess": false,
                "compatibilityMode": false,
                "bySystem": false
              },
              "genericRules": {
                "restrictGenericOwner": false
              },
              "multiLevelSecurity": {
                "quiet": false,
                "stable": false,
                "noWriteDown": {
                  "enabled": false,
                  "options": {}
                },
                "active": {
                  "enabled": false,
                  "options": {}
                },
                "fileSystem": false,
                "interprocessCommunications": false,
                "nameHiding": false
              },
              "appc": {
                "maxSessionKeyInterval": 30
              },
              "kerberos": {
                "encryptionLevel": 0
              },
              "languageDefaults": {
                "primary": "enu",
                "secondary": "enu"
              }
            }
          ]
        }
      ]
    },
    "returnCode": 0,
    "reasonCode": 0,
    "runningUserid": "testuser"
  }
}