Skip to content

msradam/oipcs

 
 

ipcs-cli

Command-line interface for z/OS IPCS dump analysis.

Built on pyIPCS.


Installation

See GETTING_STARTED.md for dependencies and installation.


Quick Start

# Inspect a dump
ipcs dump inspect MY.DUMP.DSN

# List all ASIDs
ipcs dump list-asids MY.DUMP.DSN

# Run an IPCS subcommand
ipcs run MY.DUMP.DSN STATUS REGISTERS

# Hex utilities (no z/OS required)
ipcs hex get-byte 4F3A2B1C 0
ipcs util psw-parse 078D1000800000000000000000ABCDEF

JSON output for scripting or agent use:

ipcs dump inspect MY.DUMP.DSN --output json
NO_COLOR=1 ipcs dump list-asids MY.DUMP.DSN

Commands

ipcs dump

Command Description
header <dsname> Dump header info (no session required)
inspect <dsname> Full dump inspection
list-asids <dsname> All ASIDs at time of dump
asid-to-job <dsname> <asid> Resolve ASID to jobname
job-to-asid <dsname> <jobname> Resolve jobname to ASIDs
storage-areas <dsname> Dumped storage areas

ipcs run

ipcs run <dsname> <subcommand...>
ipcs run <dsname> --subcmd "STATUS REGISTERS" --subcmd "IPLDATA" --batch

ipcs hex

No z/OS required.

Command Description
get-byte <value> <index> Extract byte at index
get-word <value> <index> Extract word at index
get-doubleword <value> <index> Extract doubleword
get-nibble <value> <index> Extract nibble
get-half-word <value> <index> Extract half-word
resize <value> <bits> Pad or truncate to bit length
bit-len <value> Bit length
check-bit <value> <index> Test bit
turn-on-bit <value> <index> Set bit
turn-off-bit <value> <index> Clear bit
concat <value> <other>... Concatenate hex values
to-int <value> Convert to integer
to-str <value> Convert to hex string
to-char <value> Decode to character string

All get-* commands accept --from-right to index from the right.

ipcs util

Command z/OS Description
psw-parse <psw> No Parse PSW fields
psw-scrunch <psw> No Compress 128-bit PSW to 64-bit
is-dump <dsname> Yes Check if dataset is a dump
opcode <dsname> <instr> Yes Resolve instruction mnemonic
addr-key <dsname> <addr> Yes Get storage key at address
addr-fetch-protected <dsname> <addr> Yes Check fetch protection

Options

All commands accept:

  • --output [text|json] — default text
  • --hlq TEXT — high-level qualifier for session datasets
  • --directory TEXT — working directory for session files
  • --debug — full tracebacks on error

Versioning

MAJOR.MINOR.PATCH following the same convention as pyIPCS.

See CHANGELOG.md.


Development

Install with dev dependencies:

pip install -e ".[dev]"

Run all checks:

bash scripts/check.sh

License

Apache-2.0

About

CLI wrapper around z/OS IPCS dump analysis

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Python 98.6%
  • Shell 1.4%