SS5K6E_10.0.0 - Documentation Index

Table of Contents

• Welcome
• Product overview of IBM MQ Appliance
  • Getting started with the M2004 IBM MQ Appliance
  • Introduction to the IBM MQ Appliance
  • Appliances and the appliance firmware
    • Relationship with IBM DataPower appliances
  • Appliance comparison: M2004 and M2003
  • What's new and changed in release 10.0.0
    • IBM MQ Appliance product identifiers and export information
  • High availability
    • Disaster recovery for a high availability configuration
  • Disaster recovery
  • Accessibility features for IBM MQ Appliance
  • Notices
  • European Union Declaration of Conformity - M2003
• Planning
  • Differences between administering an IBM MQ Appliance and an IBM MQ installation
  • Differences between queue managers that are running on the IBM MQ Appliance and an IBM MQ installation
    • Exits and services on the IBM MQ Appliance
    • Queue manager configuration on the IBM MQ Appliance
    • IBM MQ objects on the IBM MQ Appliance
    • Unsupported objects and MQSC commands on the IBM MQ Appliance
  • Planning a high availability system
    • Network requirements for high availability
    • Performance capacity for high availability
  • Planning a disaster recovery system
    • Hardware limitations for disaster recovery
  • Planning network connections
    • Network connections on an M2003 appliance
    • Network connections on an M2004 appliance
    • Network configuration guidance
  • Capacity planning
  • IBM MQ and IBM MQ Appliance on premises considerations for GDPR readiness
  • Security planning
  • Relocating your appliances
• Installing the M2003 appliance
  • Safety
    • Guidelines for servicing electrical equipment
    • Inspecting for unsafe conditions
    • Safety statements
    • Labels
  • Introducing the IBM MQ Appliance M2003
    • Identifying components
    • Specifications and features
  • Installation preparation
  • Installation of the appliance in a rack
    • Installing rails in the rack frame
    • Installing the appliance on the rails
    • Considerations when connecting the appliance to AC power sources
    • Considerations when connecting the appliance to your network
  • Setting up the initial firmware configuration
    • Configuration requirements
    • Installation considerations
    • 1 of 3: Connecting the serial cable to the appliance
    • 2 of 3: Initializing the appliance
    • 3 of 3: Accepting the license agreement
    • Completing the configuration
  • Diagnostics and the appliance
    • M2003 LED diagnostics
    • Hardware testing from the CLI
    • Running the diagnostic self-test
    • Status providers for sensors
  • Troubleshooting your appliance
    • Troubleshooting fan modules
    • Troubleshooting power supply modules
    • Troubleshooting solid-state disk drive modules
    • Troubleshooting the appliance
  • Replacing parts
    • Part listings
    • Turning off the appliance
    • Replacing a fan module
    • Replacing a power supply module
    • Replacing a solid-state disk drive module
    • Replacing an Ethernet module
    • Replacing an SFP+, a QSFP+ transceiver, or a QSFP28 transceiver
    • Removing the appliance from the rack
    • Replacing an appliance
    • End-of-life recycling
• Installing the M2004 appliance
  • Quick Start Guide
  • Specifications and features
    • Managing intrusion detection
  • Identifying components
    • LCD module
    • Locate LED
    • Power button
    • Console port
    • USB ports
    • Network ports
    • Solid-state drive modules
    • Fan modules
    • Power supply modules
  • Installation preparation
  • Installation of the appliance in a rack
    • Installing rails in the rack frame
    • Installing the appliance on the rails
    • Power cord compliance to connect the appliance to AC power sources
    • Cable compliance to connect the appliance to your network
  • Setting up the initial configuration
    • Configuration requirements
    • Installation considerations
    • Establishing a serial connection to the appliance
    • Initializing the appliance
    • Accepting the license agreement
    • Completing the configuration
  • Diagnostics and the appliance
    • LED diagnostics
    • Hardware testing from the CLI
    • Running the diagnostic utility
    • Sensors status providers
  • Troubleshooting an appliance
    • Troubleshooting fan modules
    • Troubleshooting power supply modules
    • Troubleshooting solid-state drive modules
    • Troubleshooting the appliance
  • Replacing parts
    • Installation guidelines
      • Guidelines for handling static-sensitive devices
    • M2004 part listing
    • Controlling power
      • Turning off the power to the appliance
      • Turning on the power to the appliance
    • CRU part replacement
      • Replacing a fan module
      • Replacing a power supply module
      • Replacing a solid-state drive module
      • Replacing an Ethernet module
      • Replacing an SFP transceiver
      • Removing the appliance from the rack
      • Replacing an appliance
  • Recycling the appliance at end-of-life
• Upgrading firmware or hardware
  • Upgrading and downgrading firmware
    • Installing new firmware
      • Overview of installing a new level of firmware by using the command line
        • Upgrading a version 10.0 HA configuration
        • Upgrading a version 10.0 DR configuration
        • Upgrading a version 10.0 HA configuration with DR
        • Upgrading a version 10.0 double HA configuration with DR
      • Overview of installing a new level of firmware by using the IBM MQ Appliance web UI
      • Upgrading the IBM MQ Appliance firmware from version 9.4 to version 10.0
        • Upgrading to version 10.0 by using the command line
        • Upgrading to version 10.0 by using the IBM MQ Console
        • Upgrading a version 9.4 HA configuration to version 10.0
        • Upgrading a version 9.4 HA configuration with DR to version 10.0
        • Upgrading a version 9.4 double HA configuration with DR to version 10.0
        • Upgrading a version 9.4 DR configuration to version 10.0
    • Reverting firmware
      • Reverting to the previous level of firmware by using the command line
      • Reverting to the previous level of firmware by using the IBM MQ Appliance web UI
    • Downgrading an appliance
    • Suspending an appliance from an HA group for maintenance
  • Upgrading and replacing hardware
    • Replacing an appliance by using back up and restore
    • Transfer from an existing high availability pair of appliances to a new pair of appliances
      • Transferring from your first HA appliance
      • Preparing the new HA1 appliance
      • Recreating the HA group on the new HA1 appliance
      • Transferring queue managers from the HA2 appliance to the new HA1 appliance
      • Preparing the new HA2 appliance
      • Recreating the HA group on the new HA2 appliance
    • Transfer from an existing appliance in a disaster recovery configuration
      • Transferring from the main appliance
      • Preparing the new main appliance
      • Transferring queue managers to the new main appliance
      • Replacing the recovery appliance
    • Transfer to a new appliance by using DR replication
      • Preparing the appliance
      • Transferring queue managers to the new appliance
    • Replacing a failed appliance in an HA or DR configuration
• Configuring
  • Command line access
    • Connecting to the serial port
    • Configuring the SSH service
      • Using the IBM MQ Console
      • Using the command line
  • Configuring the IBM MQ Appliance web UI
    • Changing the IBM MQ Appliance web UI IP address and port
    • Configuring certificates for IBM MQ Appliance web UI
  • Customizing the user interfaces
    • Supported markup for the user interface customization file
    • Template of the custom user interface file
  • Configuring the appliance
    • Ethernet interfaces
      • Configuring Ethernet interfaces by using the IBM MQ Appliance web UI
      • Configuring Ethernet interfaces by using the command line
    • VLAN interfaces
      • Configuring VLAN interfaces by using the IBM MQ Appliance web UI
      • Configuring VLAN interfaces by using the command line
    • Link aggregation interfaces
      • Configuring link aggregation interfaces by using the IBM MQ Appliance web UI
      • Configuring link aggregation interfaces by using the command line
    • IPMI Settings
      • Configuring IPMI LAN channels by using the command line interface
      • Configuring IPMI users by using the command line interface
    • DNS settings
      • Configuring DNS settings by using the IBM MQ Appliance web UI
      • Configuring DNS settings by using the command line
      • Clearing hosts from the DNS cache
    • SNMP Settings
      • Specifying main SNMP settings by using the web UI
      • Viewing MIBs by using the web UI
      • Configuring default trap events by using the web UI
      • Configuring SNMPv3 settings by using the command line
      • Configuring SNMPv1 or v2c settings by using the command line
      • Configuring default trap events by using the command line
      • SNMP validation
        • Creating an SNMP log target
        • Testing the SNMP log target
        • Adding event subscriptions
        • Troubleshooting SNMP notifications
    • Configuring the locale, date, and time
      • Configuring NTP service settings by using the IBM MQ Appliance web UI
      • Configuring NTP service settings by using the command line
      • Configuring the timezone by using the IBM MQ Appliance web UI
      • Configuring timezone settings by using the command line
      • Configuring the locale by using the IBM MQ Appliance web UI
      • Configuring the locale by using the command line
    • Configuring the appliance name
      • Configuring the appliance name by using the IBM MQ Appliance web UI
      • Configuring the appliance name by using the command line
      • Querying the appliance name by using the command line
    • Configuring appliance user access
    • Configuring the REST management interface
      • Configuring the REST management interface by using the IBM MQ Appliance web UI
      • Configuring the REST management interface by using the command line
      • Configuring certificates for the REST management interface
  • Configuring the appliance by using the REST management interface
    • Retrieving configuration information by using REST
    • Modifying and deleting existing configurations by using REST
    • Creating configurations by using REST
  • Configuring user access to the IBM MQ Console, REST API, and the CLI
    • Granting full administrative access to appliance system settings and IBM MQ
    • Granting full administrative access to appliance system settings but barring access to IBM MQ
    • Granting access to IBM MQ but barring access to the appliance system settings
    • Granting limited access to a queue manager
    • Granting access to the messaging REST API
  • Configuring queue managers
  • Configuring uniform clusters - appliance-specific considerations
  • Configuring environment variables
    • Adding an environment variable
    • Modifying an environment variable
    • Removing an environment variable
    • Viewing environment variables
  • Configuring IBM MQ Advanced Message Security
    • Configuring MCA interception
  • Configuring high availability
    • Configuring the hardware for high availability
      • Changing IP addresses in high availability configurations
      • Changing appliance names in high availability configurations
      • Configuring custom HA replication interfaces
    • Configuring the high availability group
      • Creating a high availability group
        • Creating a high availability group by using the command line
        • IBM MQ Console: Creating a high availability group
      • Viewing the status of appliances in a high availability group
        • Viewing the high availability status by using the command line
        • Viewing the high availability status by using the IBM MQ Console
      • Deleting a high availability group
        • Deleting a high availability group by using the command line
        • IBM MQ Console: Deleting a high availability group
    • Configuring high availability queue managers
      • Creating a high availability queue manager
        • Creating a high availability queue manager by using the command line
        • IBM MQ Console: Creating a high availability queue manager
      • Adding an existing queue manager to a high availability group
        • Adding an existing queue manager to a high availability group by using the command line
        • IBM MQ Console: Adding a queue manager to the high availability configuration
      • Specifying a floating IP address for a queue manager
      • Viewing the status of a high availability queue manager
      • Removing a queue manager from a high availability group
        • Removing a queue manager from a high availability group by using the command line
        • IBM MQ Console: Removing a queue manager from a high availability configuration
    • Configuring error reporting for high availability
    • Example network set up for HA configuration
    • Secure replication for a high availability queue manager
    • Secure heartbeat for high availability
    • Configuring disaster recovery for a high availability queue manager
      • Configuring disaster recovery for a high availability queue manager by using the command line
      • Configuring disaster recovery for a high availability queue manager by using the web console
      • Example network set up for HA/DR configuration
    • Configuring disaster recovery fail over to another high availability group
      • Configuring disaster recovery fail over to another high availability group by using the command line
      • Configuring disaster recovery fail over to another high availability group by using the web console
      • Example network set up for HA/DR configuration with two HA groups
    • Replacing a node in a high availability group
    • Causes of HA failover
  • Configuring disaster recovery
    • Configuring the hardware for disaster recovery
      • Changing IP addresses in disaster recovery configurations
      • Changing appliance names in disaster recovery configurations
      • Configuring custom DR replication interfaces
    • Configuring disaster recovery for queue managers
      • Configuring queue managers for disaster recovery by using the command line
      • IBM MQ Console: Setting up disaster recovery
      • Removing a queue manager from a disaster recovery configuration by using the command line
      • IBM MQ Console: Removing a queue manager from disaster recovery
      • Viewing the status of a disaster recovery queue manager
    • Configuring disaster recovery for a high availability queue manager
      • Configuring disaster recovery for a high availability queue manager by using the command line
      • Configuring disaster recovery for a high availability queue manager by using the web console
      • Example network set up for HA/DR configuration
    • Secure replication for a disaster recovery queue manager
    • Configuring disaster recovery fail over to another high availability group
      • Configuring disaster recovery fail over to another high availability group by using the command line
      • Configuring disaster recovery fail over to another high availability group by using the web console
      • Example network set up for HA/DR configuration with two HA groups
      • Creating a floating IP address
  • Configuring the IBM MQ Console and REST API
    • Configuring logging for administrative REST API and IBM MQ Console
    • Configuring the LTPA token expiry interval
    • Configuring the response timeout
    • Configuring CORS for the REST API
  • Configuring an Aspera gateway connection
  • Configuring Kafka connectors
• Administering
  • Using the IBM MQ Console
    • Quick tour of the IBM MQ Console
      • IBM MQ Console: Working with local queue managers
        • IBM MQ Console: Working with authentication information objects
        • IBM MQ Console: Working with queue manager authority records
        • IBM MQ Console: Working with channel authentication records
        • IBM MQ Console: Working with listeners
        • IBM MQ Console: Viewing queue manager status
      • IBM MQ Console: Creating a high availability group
        • IBM MQ Console: Creating a high availability queue manager
        • IBM MQ Console: Adding a queue manager to the high availability configuration
        • IBM MQ Console: Removing a queue manager from a high availability configuration
        • IBM MQ Console: Deleting a high availability group
      • IBM MQ Console: Setting up disaster recovery
        • IBM MQ Console: Removing a queue manager from disaster recovery
      • IBM MQ Console: Working with IBM MQ objects
        • IBM MQ Console: Working with queues
        • IBM MQ Console: Working with topics
        • IBM MQ Console: Working with subscriptions
        • IBM MQ Console: Working with queue manager channels
        • IBM MQ Console: Working with application channels
        • IBM MQ Console: Working with applications
        • IBM MQ Console: Filtering objects displayed in tables
  • Administering IBM MQ by using the REST API
  • Message queue control commands
  • Administering messaging users
    • Defining external users
  • Using MQSC commands
  • Using an IBM MQ client
    • Setting up a queue manager to accept client connections
    • Putting and getting messages
    • Publishing and subscribing
    • Browsing a message queue
    • Creating and downloading a CCDT file
      • Example client connection using CCDT
  • Processing dead-letter queues
  • Starting and stopping the appliance
  • Back up and restore
    • Secure backup
      • Creating a certificate for a secure backup
      • Creating a secure backup by using the CLI
      • Creating a secure backup by using the IBM MQ Appliance web UI
      • Creating a secure backup by using the REST interface
    • Secure restore
      • Creating an identity credentials object for a secure backup restore
      • Restoring a secure backup by using the CLI
      • Restoring a secure backup by using the IBM MQ Appliance web UI
      • Restoring a secure backup by using the REST interface
    • Backing up a key repository
      • Key repository archive format
    • Restoring a key repository
    • Backing up a queue manager
    • Restoring a queue manager
    • Back up and restore - individual components
      • Backing up or saving the appliance configuration
      • Restoring the appliance configuration
      • Backing up messaging users
      • Restoring messaging users
  • Factory reset
  • Triggering appliance operations by using the REST management interface
  • Operating in a high availability environment
    • Suspending an appliance from an HA group for maintenance
      • Suspending an appliance from an HA group by using the command line
      • Suspending an appliance from an HA group by using the IBM MQ Console
    • Replacing a node in a high availability group
    • Managing queue manager locations in a high availability group
    • Viewing the status of appliances in a high availability group
      • Viewing the high availability status by using the command line
      • Viewing the high availability status by using the IBM MQ Console
    • Viewing the status of a high availability queue manager
    • Failed resource actions
    • Regenerating the keys for secure communication of the HA pair
    • Disaster recovery for a high availability queue manager
    • Causes of HA failover
  • Operating in a disaster recovery environment
    • Switching over to a recovery appliance
    • Switching back to the main appliance
      • Switching back to the main appliance by using the command line
      • Switching back to the main appliance by using IBM MQ Console
    • Replacing a failed node in a disaster recovery configuration
    • Replacing failed high availability nodes in a disaster recovery configuration
    • Testing the recovery appliance
    • Reversing disaster recovery roles
    • Viewing the status of a disaster recovery queue manager
  • Operating in a DR/HA environment - legacy solution
  • Operating in a DR/HA environment
    • Replacing a failed appliance in a DR/HA configuration
  • Managing files by using the IBM MQ Appliance web UI
  • Managing files by using the REST management interface
  • Watchdog timer
• Migrating and consolidating
  • Moving queue managers from other IBM MQ platforms
    • Moving a queue manager
    • Moving queue managers secured by using TLS
    • Planning for incompatible features in the queue manager
    • Handling incompatible features in the queue manager
    • Editing qm.ini files
      • Adding a value to the configuration file
      • Deleting a value from a qm.ini file
      • Viewing a configuration file
  • Relocating your appliances
• Security
  • Types of user and how they are authenticated
  • User authorization, credential mapping, and access profiles
    • Access policies
  • Role based management
    • Important: avoiding user lock out when configuring role based management
    • User authentication with LDAP
      • Configuring direct authentication with LDAP by using the web UI
      • Configuring direct authentication with LDAP by using the command line
      • Configuring look up authentication with LDAP by using the web UI
      • Configuring look up authentication with LDAP by using the command line
      • Creating an TLS client profile by using the web UI
      • Creating a TLS client profile by using the command line
      • Creating a load balancer group profile by using the web UI
      • Creating a load balancer group profile by using the command line
    • User authentication with XML file
      • Configuring user authentication with an XML file by using the web UI
      • Configuring user authentication with an XML file by using the command line
    • User authentication with local users
      • Configuring user authentication with local users by using the web UI
      • Configuring user authentication with local users by using the command line
    • User authentication with TLS user certificates
      • Configuring user authentication with a TLS user certificate by using the Web UI
      • Configuring user authentication with a TLS user certificate by using the command line
      • Using an alternative user name (TLS certificate)
      • Credential mapping for TLS certificate users
    • User authentication with OIDC
      • Configuring user authentication with OIDC by using the Web UI
      • Configuring user authentication with OIDC by using the command line
      • Using an alternative user name (OIDC)
      • Credential mapping for OIDC users
    • SSH authentication for CLI sessions
      • Defining SSH authentication for CLI sessions by using the Web UI
        • Managing the SSH revoked keys list for authenticating CLI sessions
      • Defining SSH authentication for CLI sessions by using the CLI
        • Revoking SSH keys by using the command line
      • OpenSSH keys
    • Credential mapping with an XML file
      • Configuring credential mapping with an XML file by using the web UI
      • Configuring credential mapping with an XML file by using the command line
    • Credential mapping with local user groups
      • Configuring credential mapping with local user groups by using the Web UI
      • Configuring credential mapping with local user groups by using the command line
    • Password policy
      • Configuring a password policy by using the web UI
      • Configuring a password policy by using the command line
    • Account policy
      • Configuring an account policy by using the web UI
      • Configuring an account policy by using the command line
    • Local users and user groups
      • Configuring local users by using the web UI
      • Configuring local users by using the command line
      • Configuring local user groups by using the web UI
      • Configuring local user groups by using the command line
    • Example RBM XML file
  • Routine user administration
    • Changing your own password by using the IBM MQ Appliance web UI
    • Changing your own password by using the command line
    • Resetting a user's password by using the IBM MQ Appliance web UI
    • Resetting a user's password by using the command line
    • Forcing a password change by using the IBM MQ Appliance web UI
    • Forcing a password change by using the command line
    • Resetting failed login count by using the IBM MQ Appliance web UI
    • Resetting failed login count by using the command line
  • File system encryption
    • Creating a queue manager with an encrypted file system
    • Creating an encrypted file system for an existing queue manager
    • Scheduling encryption for system file systems
    • Scheduling decryption for system file systems
    • Managing file system encryption passphrases
    • Failsafe mode following RAID problems
  • TLS certificate management
    • Working with self-signed certificates
      • Creating a self-signed certificate
      • Adding the public part of a self-signed certificate
    • Working with CA-signed certificates
      • Creating a certificate request
      • Receiving a CA-signed certificate
      • Listing certificate requests for a queue manager
      • Viewing a certificate request for a queue manager
      • Deleting a certificate request
      • Adding a CA certificate
      • Renewing a CA-signed certificate
    • Listing certificates for a queue manager
    • Viewing a certificate for a queue manager
    • Renaming a certificate
    • Validating a certificate
    • Deleting a certificate
    • Managing certificates on the appliance
      • Downloading certificates from the appliance
      • Uploading certificates to the appliance
      • Deleting certificates from the appliance
      • Configuring certificates for IBM MQ Appliance web UI
    • Certificate monitor
      • Configuring the certificate monitor by using the command line
      • Configuring the certificate monitor by using the IBM MQ Appliance web UI
      • Configuring the certificate monitor by using the REST API
  • TLS connections
    • Creating a TLS client profile
    • Creating a TLS server profile
  • FIPS compliance
  • Audit trail
• Monitoring and reporting
  • IBM MQ appliance logs
    • IBM MQ error logs
      • Viewing system error log files
      • Viewing queue manager error log files
        • Viewing queue manager error log files by using the command line
        • Viewing queue manager error log files by using the IBM MQ Appliance web UI
        • Configuring queue manager error logs
      • Viewing the IBM MQ first failure data captures
      • Deleting log files
      • Downloading error logs
    • IBM MQ diagnostic message services
      • Configuring diagnostic message services
      • Default diagnostic message services
    • Appliance audit logs
      • Audit log
      • CLI log
      • Writing audit log data to a syslog target
    • Appliance log targets
      • Configuring log targets using the IBM MQ Appliance web UI
      • Configuring log targets using the command line
      • Format of IBM MQ logs sent to log targets
      • Log target examples
  • Monitoring system resource usage
    • Monitoring system resource usage by using the status command
    • Monitoring system resource usage by using the amqsrua command
    • Monitoring the appliance by using the show command
    • Developing your own resource monitoring program
  • Monitoring queue manager health
  • Disk space monitoring
    • Creating a log target for the file system monitor
    • Configuring the file system monitor
    • Viewing the file system usage monitor configuration
  • Monitoring the health of high availability and disaster recovery configurations
    • HA notification examples
    • DR notification examples
  • OpenTelemetry integration
    • Enabling and disabling OpenTelemetry tracing
    • IBM MQ OpenTelemetry tracing service configuration
      • Displaying the IBM MQ OpenTelemetry tracing service settings
      • Modifying the IBM MQ OpenTelemetry tracing service settings
    • Displaying the status of the IBM MQ OpenTelemetry tracing service
  • Application activity trace
    • Subscriptions to application activity trace
    • Creating subscriptions to application activity trace
    • Using amqsact to view trace messages
    • Configuring trace levels
  • System topics for monitoring and activity trace
  • Monitoring the appliance by using the REST management interface
    • Example of retrieving status by using REST
  • Monitoring the IBM MQ Appliance by using SNMP
• Troubleshooting
  • Appliance error reports
    • Configuring failure notification using the web UI
    • Generating error reports
    • Viewing error reports
    • Sending error reports
  • Using trace
  • Resolving a partitioned problem in a high availability configuration
  • Resolving a partitioned problem in a disaster recovery configuration
  • Resolving an HA queue manager left in an indeterminate state
  • Troubleshooting problems with HA queue manager run locations
  • Replacing a node in a high availability group
  • Troubleshooting queue manager file systems
  • Troubleshooting file copy
  • Problems resizing queue managers
  • Help with using runmqras
  • Failsafe mode
    • Failsafe mode following RAID problems
  • Recovering from hardware failures
    • Appliance fails, all disks unaffected
    • Appliance fails, three disks unaffected
    • Appliance operational, one disk in RAID set fails
• Reference
  • Command reference
    • IBM MQ commands
      • IBM MQ Control commands
        • crtmqm (create queue manager)
        • dltmqm (delete queue manager)
        • dmpmqcfg (dump queue manager configuration)
        • dspamqp (display AMQP server properties)
        • dspmq (display queue managers)
        • dspmqrte (display route)
        • dspmqtrc (display formatted trace)
        • dspmqtrn (display transactions)
        • dspmqver (display version information)
        • dspmqweb (display mqweb server configuration)
        • endmqm (end queue manager)
        • endmqtrc (end trace)
        • mqperfck (MQ performance check)
        • mqrc (mq return code)
        • rcrmqobj (re-create object)
        • rsvmqtrn (resolve transaction)
        • runmqras (run diagnostics collection)
        • runmqsc (run mqsc commands)
        • runswchl (switch cluster channel)
        • setamqp (set AMQP server properties)
        • setmqweb (set mqweb server configuration)
        • strmqm (start queue manager)
        • strmqtrc (start trace)
      • IBM MQ configuration commands
        • dspmqini (display mq ini)
        • dspmqvar (display mq variables)
        • setmqini (set mq ini)
        • setmqvar (set mq variable)
      • Messaging user and group commands
        • usercreate (create user)
        • userdelete (delete user)
        • usermodify (modify user)
        • userlist (list users)
        • groupcreate (create user group)
        • groupdelete (delete user group)
        • grouplist (list user groups)
        • userbackup (back up users)
        • userrestore (restore user)
      • Queue manager security management commands
        • addcert (add certificate)
        • createcert (create certificate)
        • createcertrequest (create certificate request)
        • deletecert (delete certificate)
        • deletecertrequest (delete certificate request)
        • detailcert (detail certificate)
        • detailcertrequest (detail certificate request)
        • dspcrl (show certificate revocation list details)
        • dspfspass (display information about file system passphrases)
        • dspamschl (display AMS channel)
        • dsprepcert (display TLSHD)
        • keybackup (key backup)
        • keyrestore (key restore)
        • listcert (list certificate)
        • listcertrequest (list certificate request)
        • receivecert (receive certificate)
        • recreatecertrequest (re-create certificate request)
        • renamecert (rename certificate)
        • setamschl (set AMS channel)
        • setcrl (set certificate revocation list)
        • setfspass (manage encryption file system passphrases)
        • setrepcert (set replication certificate)
        • validatecert (validate certificate)
      • Queue manager commands
        • crtmqm (create queue manager)
        • dltmqm (delete queue manager)
        • dmpmqcfg (dump queue manager configuration)
        • dspmq (display queue managers)
        • endmqm (end queue manager)
        • runmqsc (run MQSC commands)
        • setmqsize (increase queue manager file system size)
        • strmqm (start queue manager)
        • status
      • Back up and restore commands
        • createbackupfs: create appliance storage location for back up
        • deletebackupfs: clear previously allocated back up space
        • mqbackup: back up queue manager
        • mqrestore: restore queue manager from back up
      • High availability commands
        • cleanha (clear HA failed resource actions)
        • crthagrp (create HA group)
        • crthakeys (create HA keys)
        • dsphagrp (display HA group status)
        • dsphakeys (display HA key information)
        • dsphalink
        • dlthagrp (delete HA group)
        • makehaprimary (make HA appliance primary)
        • prepareha (prepare appliance for HA group)
        • sethagrp (set HA group)
        • sethaint
        • sethalink
        • sethapreferred (set HA preferred appliance)
        • clearhapreferred (clear HA preferred appliance)
      • Disaster recovery commands
        • crtdrprimary
        • crtdrsecondary
        • dltdrprimary
        • dltdrsecondary
        • dspdrlink
        • dspdrsecondary
        • makedrprimary
        • makedrsecondary
        • setdrlink
      • OpenTelemetry tracing service commands
        • setmqots (set OpenTelemetry trace configuration)
        • dspmqots (display OpenTelemetry trace configuration)
      • Troubleshooting commands
        • dltmqras (delete mq ras)
        • dspmqerr (display mq error log)
        • dspmqrte (display route information)
        • dspmqtrc (display formatted trace)
        • endmqtrc (end trace)
        • mqrc
        • runmqras
        • strmqtrc (Start trace)
    • Appliance commands
      • Appliance commands
        • admin-state
        • cancel
        • clear intrusion-detected
        • clock
        • configure terminal
        • diagnostics
        • disconnect
        • echo
        • exec
        • exit
        • help
        • login
        • ping
        • reset
        • show
        • shutdown
        • summary
        • template
        • test tcp-connection
        • traceroute
      • Appliance user commands
        • access-level
        • group
        • password
        • snmp-cred
        • suppress-password-change
      • Appliance user group commands
        • access-policy
      • Audit Log Settings commands
        • rotate
        • size
      • Certificate Monitor commands
        • disable-expired-certs
        • log-level
        • poll
        • reminder
      • Crypto commands
        • cert-monitor
        • certificate
        • convert-certificate
        • convert-key
        • crl
        • crypto-export
        • crypto-import
        • crypto-mode-set
        • idcred
        • key
        • keygen
        • password-map
        • profile (deprecated)
        • sshserverprofile
        • sskey
        • ssl-client
        • ssl-server
        • test password-map
        • valcred
      • Date, time, and locale configuration commands
        • custom
        • daylight-name
        • daylight-offset
        • daylight-start-day
        • daylight-start-hours
        • daylight-start-minutes
        • daylight-start-month
        • daylight-start-week
        • daylight-stop-day
        • daylight-stop-hours
        • daylight-stop-minutes
        • daylight-stop-month
        • daylight-stop-week
        • direction
        • name
        • offset-hours
        • offset-minutes
        • refresh-interval
        • remote-server
        • timeout
      • DNS commands
        • force-ip-preference
        • ip-preference
        • load-balance
        • name-server
        • retries
        • search-domain
        • static-host
        • timeout
      • Ethernet commands
        • flow-control
        • force-mode
        • disable-ethernet-hardware-offload
        • hardware-offload
        • ip-address
        • ip-config-mode
        • ip-route
        • ip-secondary-address
        • ipv4-default-gateway
        • ipv6-dadtransmits
        • ipv6-default-gateway
        • ipv6-nd-retransmit-timer
        • link-aggegation-mode
        • lldp-hardware-offload
        • mac-address
        • mode
        • mtu
        • packet-capture
      • Failure notification commands
        • always-on-shutdown
        • always-on-startup
        • email-address
        • email-sender-address
        • ffdc event-log
        • ffdc memory-trace
        • ffdc packet-capture
        • internal-state
        • location-id
        • protocol
        • remote-address
        • report-history
        • upload-report
        • use-smtp
      • File commands
        • copy
        • delete
        • dir
        • move
      • File system usage monitor commands
        • poll
        • all-qm
        • all-qm-critical
        • all-qm-warning
        • all-system
        • all-system-critical
        • all-system-warning
        • qm
        • system
      • Global configuration commands
        • acl
        • audit-log-settings
        • clear dns-cache
        • clear rbm cache
        • crypto
        • dns
        • ethernet
        • failure-notification
        • flash
        • fs-usage-monitor
        • host-alias
        • ipmi-lan-channel
        • ipmi-user
        • known-host
        • language
        • ldap-search-parameters
        • link-aggregation
        • loadbalancer-group
        • logging target
        • logsize
        • mkdir
        • network
        • ntp-service
        • packet-capture-advanced
        • raid-activate
        • raid-delete
        • raid-initialize
        • raid-learn-battery
        • raid-rebuild
        • raid-volume
        • rbm
        • reset failed-login
        • reset-ssh-keys
        • reset username
        • rest-mgmt
        • rmdir
        • save error-report
        • secure-backup
        • secure-restore
        • send error-report
        • snmp
        • ssh
        • system
        • timezone
        • top
        • undo
        • user
        • usergroup
        • user-expire-password
        • user-password
        • vlan
        • web-mgmt
        • write memory
      • Host Alias commands
        • ip-address
      • Initialization commands
        • boot config
        • boot delete
        • boot image
        • boot switch
        • boot update
        • reinitialize
        • shutdown
        • verify-firmware
      • IPMI user commands
        • password
        • user-id
      • IPMI LAN channel commands
        • allowed-user
        • ip address
        • ip default-gateway
        • maximum-channel-privilege-level
        • sol-enabled
        • sol-required-user-privilege-level
      • LDAP Search Parameters commands
        • base-dn
        • filter-prefix
        • filter-suffix
        • returned-attribute
        • scope
      • Link aggregation commands
        • ip-address
        • ip-config-mode
        • ip-route
        • ip-secondary-address
        • ipv4-default-gateway
        • ipv6-dadtransmits
        • ipv6-default-gateway
        • ipv6-nd-retransmit-timer
        • lacp-hash
        • lacp-select
        • link
        • MTU
        • packet-capture
        • type
        • yield-standby
      • Load Balancer Group commands
        • algorithm
        • damp
        • giveup-when-all-members-down
        • health-check
        • masquerade
        • server
        • try-every-server
      • Log target commands
        • active-timeout
        • ansi-color
        • archive-mode
        • connect-timeout
        • backup
        • email-address
        • event
        • event-code
        • event-detection
        • event-filter
        • facility
        • feedback-detection
        • format
        • idle-timeout
        • ip-filter
        • local-address
        • local-file
        • local-ident
        • object
        • priority
        • rate-limit
        • remote-address
        • remote-directory
        • remote-login
        • remote-port
        • rotate
        • sender-address
        • size
        • smtp-domain
        • soap-version
        • ssl
        • ssl-client
        • ssl-client-type
        • suppression-period
        • timestamp
        • trigger
        • type
        • upload-method
        • url
      • Monitoring and reporting commands
        • status
        • show
          • show audit-log
          • show audit-search
          • show certificate
          • show clock
          • show file
          • show firmware
          • show firmware-version
          • show fs-usage-monitor
          • show ipaddress
          • show ipmi-lan-channel
          • show ipmi-user
          • show key
          • show link-aggregation-member-status
          • show link-aggregation-status
          • show link
          • show load
          • show log
          • show logging
          • show loglevel
          • show mq-resources
          • show ndcache
          • show network-interface
          • show ntp-refresh
          • show op-state
          • show password-map
          • show profile
          • show qm-status
          • show raid-array
          • show raid-battery-module
          • show raid-controller
          • show raid-logical-drive
          • show raid-physical-drive
          • show raid-ssd
          • show rbm
          • show route
          • show sensors-current
          • show sensors-fans
          • show sensors-other
          • show sensors-temperature
          • show sensors-voltage
          • show services
          • show services-memory
          • show system
          • show tcp-connections
          • show tcp-table
          • show tcp
          • show throughput
          • show time
          • show users
          • show usernames
          • show version
      • Network commands
        • arp-interval
        • arp-retries
        • destination-routing
        • disable-interface-isolation
        • ecn-disable
        • ephemeral-port-range
        • icmp-disable
        • relax-interface-isolation
        • reverse-path-filtering
        • tcp-retries
        • tcp-window-scale
      • RBM setting commands
        • au-cache-mode
        • au-cache-ttl
        • au-info-url
        • au-ldap-bind-dn
        • au-ldap-bind-password
        • au-ldap-parameters
        • au-ldap-readtimeout
        • au-ldap-search
        • au-method
        • au-oidc-client-id
        • au-oidc-client-secret
        • au-oidc-scope
        • au-oidc-identity-service-ssl-client
        • au-oidc-identity-service-url
        • au-oidc-key-fetch-interval
        • au-server-host
        • au-server-port
        • au-ssl-user-attribute
        • au-user-map
        • au-valcred
        • cli-timeout
        • fallback-login
        • fallback-user
        • ldap-prefix
        • ldap-sslproxy
        • ldap-suffix
        • ldap-version
        • loadbalancer-group
        • lockout-duration
        • max-login-failure
        • mc-custom-url
        • mc-info-url
        • mc-ldap-bind-password
        • mc-ldap-parameters
        • mc-ldap-readtimeout
        • mc-ldap-search
        • mc-ldap-sslproxy
        • mc-loadbalancer-group
        • mc-ldap-bind-dn
        • mc-method
        • mc-server-host
        • mc-server-port
        • password-hash-algorithm
        • pwd-aging
        • pwd-digit
        • pwd-exp-day
        • pwd-history
        • pwd-max-age
        • pwd-max-history
        • pwd-minimum-length
        • pwd-mixed-case
        • pwd-nonalphanumeric
        • pwd-username
        • restrict-admin
        • ssh-au-method
        • ssh-ca-pubkey-file
        • ssl-client
        • ssl-client-type
        • ssh-revoked-keys
      • REST Management Interface commands
        • local-address
        • port
        • ssl-config-type
        • ssl-server
      • SNMP Settings commands
        • access-level
        • community
        • ip-address
        • port
        • security-level
        • trap-code
        • trap-default-subscriptions
        • trap-priority
        • trap-target
        • user
        • version
      • SSH Server Profile commands
        • ciphers
        • host-key-alg
        • kex-alg
      • TLS Client Profile commands
        • cache-size
        • cache-timeout
        • caching
        • ciphers
        • curves
        • custom-sni-hostname
        • disable-renogotiation
        • enable-tls13-compat
        • hostname-validation-flags
        • hostname-validation-fail
        • idcred
        • protocols
        • ssl-client-features
        • valcred
        • validate-hostname
        • validate-server-cert
      • TLS hostname map commands
        • sni-mapping
      • TLS Server Profile commands
        • allow-legacy-renegotiation
        • cache-size
        • cache-timeout
        • caching
        • ciphers
        • compression
        • curves
        • disable-renogotiation
        • idcred
        • max-duration
        • max-renegotiation-allowed
        • prefer-server-ciphers
        • prioritize-chacha
        • prohibit-resume-on-reneg
        • protocols
        • request-client-auth
        • require-client-auth
        • send-client-auth-ca-list
        • sign-alg
        • ssl-options
        • valcred
        • validate-client-cert
      • TLS SNI server profile commands
        • max-duration
        • max-renogotiation-allowed
        • protocols
        • sni-server-default
        • sni-server-mapping
        • ssl-options
      • System Settings commands
        • contact
        • custom-ui-file
        • entitlement
        • locale
        • location
        • name
      • Validation Credentials commands
        • cert-validation-mode
        • certificate
        • check-dates
        • crldp
        • explicit-policy
        • initial-policy-set
        • require-crl
        • use-crl
      • VLAN Commands
        • ethernet-interface
        • identifier
        • ip-address
        • ip-config-mode
        • ip-route
        • ip-secondary-address
        • ipv4-default-gateway
        • ipv6-dadtransmits
        • ipv6-default-gateway
        • ipv6-nd-retransmit-timer
        • link-aggregation-interface
        • mtu
        • outbound-priority
        • over
        • packet-capture
      • Web management service commands
        • idle-timeout
        • local-address
        • port
        • ssl (deprecated)
        • ssl-config-type
        • ssl-server
  • REST management interface
    • REST request structure
    • REST response structure
    • REST management resources summary
    • Query parameters
    • REST API resources
      • Status resources
        • /mgmt/status/
          • GET
        • /mgmt/status/default/ActiveUsers
          • GET
        • /mgmt/status/default/CryptoModeStatus
          • GET
        • /mgmt/status/default/CurrentSensors
          • GET
        • /mgmt/status/default/DateTimeStatus
          • GET
        • /mgmt/status/default/DateTimeStatus2
          • GET
        • /mgmt/status/default/DNSCacheHostStatus4
          • GET
        • /mgmt/status/default/DNSNameServerStatus2
          • GET
        • /mgmt/status/default/DNSSearchDomainStatus
          • GET
        • /mgmt/status/default/DNSStaticHostStatus
          • GET
        • /mgmt/status/default/DomainStatus
          • GET
        • /mgmt/status/default/EnvironmentalFanSensors
          • GET
        • /mgmt/status/default/EnvironmentalSensors
          • GET
        • /mgmt/status/default/EthernetCountersStatus
          • GET
        • /mgmt/status/default/EthernetMAUStatus
          • GET
        • /mgmt/status/default/EthernetMIIStatus
          • GET
        • /mgmt/status/default/FailureNotificationStatus2
          • GET
        • /mgmt/status/default/FilesystemStatus
          • GET
        • /mgmt/status/default/FirmwareStatus2
          • GET
        • /mgmt/status/default/FirmwareStatus
          • GET
        • /mgmt/status/default/FirmwareVersion3
          • GET
        • /mgmt/status/default/IGMPStatus
          • GET
        • /mgmt/status/default/IPAddressStatus
          • GET
        • /mgmt/status/default/IPMISelEvents
          • GET
        • /mgmt/status/default/LicenseStatus
          • GET
        • /mgmt/status/default/LinkAggregationStatus
          • GET
        • /mgmt/status/default/LinkAggregationMemberStatus
          • GET
        • /mgmt/status/default/LinkStatus
          • GET
        • /mgmt/status/default/LoadBalancerStatus2
          • GET
        • /mgmt/status/default/LogTargetStatus
          • GET
        • /mgmt/status/default/MQSystemResources2
          • GET
        • /mgmt/status/default/NDCacheStatus2
          • GET
        • /mgmt/status/default/NetworkInterfaceStatus
          • GET
        • /mgmt/status/default/NTPRefreshStatus
          • GET
        • /mgmt/status/default/ObjectStatus
          • GET
        • /mgmt/status/default/OtherSensors
          • GET
        • /mgmt/status/default/PCIbus
          • GET
        • /mgmt/status/default/QueueManagersStatus
          • GET
        • /mgmt/status/default/RaidArrayStatus
          • GET
        • /mgmt/status/default/RaidBatteryModuleStatus
          • GET
        • /mgmt/status/default/RaidControllerStatus
          • GET
        • /mgmt/status/default/RaidPhysicalDriveStatus
          • GET
        • /mgmt/status/default/RaidSsdStatus
          • GET
        • /mgmt/status/default/RoutingStatus3
          • GET
        • /mgmt/status/default/ServicesMemoryStatus2
          • GET
        • /mgmt/status/default/ServicesStatus
          • GET
        • /mgmt/status/default/SNMPStatus
          • GET
        • /mgmt/status/default/SSHTrustedHostStatus
          • GET
        • /mgmt/status/default/SystemCpuStatus
          • GET
        • /mgmt/status/default/SystemMemoryStatus
          • GET
        • /mgmt/status/default/TCPSummary
          • GET
        • /mgmt/status/default/TCPTable
          • GET
        • /mgmt/status/default/TemperatureSensors
          • GET
        • /mgmt/status/default/VlanInterfaceStatus2
          • GET
        • /mgmt/status/default/VoltageSensors
          • GET
      • Actionqueue resources
        • /mgmt/actionqueue/default/operations
          • GET
        • /mgmt/metadata/default/operations/{operation}
          • GET
        • /mgmt/actionqueue/default
          • POST
            • AddPasswordMap
            • AddSelTestEntry
            • AddTrustedHost
            • ApplyPatch
            • BootDelete
            • BootSwitch
            • ChangePassword
            • ClearSel
            • ConvertCertificate
            • ConvertKey
            • CreateDir
            • CryptoExport
            • CryptoImport
            • CryptoModeSet
            • DeleteFile
            • DeletePasswordMap
            • DeleteTrustedHost
            • DisableEthernetHardwareOffload
            • DisableLinkAggregationHardwareOffload
            • DisableVLANHardwareOffload
            • Disconnect
            • ErrorReport
            • ExecConfig
            • FlushArpCache
            • FlushDNSCache
            • FlushRBMCache
            • Keygen
            • LoadConfiguration
            • LocateDevice
            • MoveFile
            • NoPasswordMap
            • Ping
            • RaidActivate
            • RaidDelete
            • RaidInitialize
            • RaidLearnBattery
            • RaidMakeHotSpare
            • RaidRebuild
            • RemoveDir
            • SaveConfig
            • SaveInternalState
            • SecureBackup
            • SecureRestore
            • SelectConfig
            • SendErrorReport
            • SendFile
            • SendLogEvent
            • SetLogLevel
            • SetRBMDebugLog
            • SetTimeAndDate
            • Shutdown
            • TCPConnectionTest
            • TestHardware
            • TraceRoute
            • UndoConfig
            • UniversalPacketCaptureDebug
            • UniversalStopPacketCapture
            • UserForcePasswordChange
            • VerifyFirmware
      • Configuration resources
        • /mgmt/config/
          • GET
        • /mgmt/config/default/CertMonitor
          • GET
          • PUT
        • /mgmt/config/default/DNSNameService
          • GET
          • PUT
        • /mgmt/config/default/ErrorReportSettings
          • GET
          • PUT
        • /mgmt/config/default/EthernetInterface
          • GET
          • PUT
        • /mgmt/config/default/FileSystemUsageMonitor
          • GET
          • PUT
        • /mgmt/config/default/Language
          • GET
          • PUT
        • /mgmt/config/default/LinkAggregation
          • GET
          • POST
        • /mgmt/config/default/LinkAggregation/name
          • GET
          • DELETE
          • PUT
        • /mgmt/config/default/SystemSettings
          • GET
          • PUT
        • /mgmt/config/default/TimeSettings
          • GET
          • PUT
        • /mgmt/config/default/User
          • GET
          • POST
        • /mgmt/config/default/User/name
          • GET
          • DELETE
          • PUT
        • /mgmt/config/default/UserGroup
          • GET
          • POST
        • /mgmt/config/default/UserGroup/name
          • GET
          • DELETE
          • PUT
        • /mgmt/config/default/VLANInterface
          • GET
          • POST
        • /mgmt/config/default/VLANInterface/name
          • GET
          • DELETE
          • PUT
      • IBM MQ administrative resources
      • IBM MQ messaging resources
  • Messages