mqsireportpolicy command

Use the mqsireportpolicy command to display the details of operational policies.

Syntax

integrationNodeSpec

Use the -t and -l parameters to display the specified policy.
Or use the -t and -a parameters to display all policies in the Integration Registry.
Or use the -t and -r parameters to display all policies and their contents in the Integration Registry.
Or use the -e and -m parameters to display only policies that are attached to the specified flow.
Use the -k and -y parameters together to specify a library that is within an application.

Parameters

integrationNodeSpec

(Required) You must specify at least one parameter to identify the target integration node for this command, in one of the following forms:

integrationNodeName

This parameter identifies the name of a specified integration node. To connect to a remote integration node, you must also specify -i and -p.

-n integrationNodeFileName

This parameter identifies the name of a .broker file that contains the connection details for a local or remote integration node. Include the location (path) and file name when you specify this parameter. You must ensure that the location is accessible when you run this command.

Use this option if multiple users want to connect to the same integration node, or if you are using advanced connection parameters such as SSL. To learn more about creating and using a .broker file, see Connecting to an integration node by creating a .broker file.

If you want to run a command that uses SSL to administer a remote integration node over a secured channel, you must specify the keystore and truststore password for the connection that is using the IBM_JAVA_OPTIONS environment variable. For more information, see Resolving problems when running commands.

-i ipAddress, -p port

These parameters identify the connection details for the integration node.

Use this option for connections to remote integration nodes that do not require advanced connection parameters.

If you are connecting to a remote integration node, you can additionally prefix integrationNodeName to explicitly set which integration node to connect to. You cannot use -n integrationNodeFileName in the same command.

Parameters that you omit assume default values:

-i ipAddress: The host name or IP address of the computer on which the integration node is running. If you do not specify this parameter, a value that represents the local computer is used.
If you want to connect to a secured integration server as a specific user, provide the security credentials as a URI in the following format: tcp://user:password@hostname. If your password contains URI Reserved characters, you must convert these characters to the percent-encoded format. For more information, see A correct URL and password returns error BIP1939 when you attempt to connect to a remote host name in Resolving problems when running commands.
-p port: The port on which the web user interface HTTP connection listener is listening. If you do not specify this parameter, the value 4414 is used.

-e integrationServerName

The name of the integration server.

-m flowName

The name of the flow to report policy on.

-t policyType

The type of policy to report on. The valid options are: DataCapture, MQEndpoint, MQTTPublish, MQTTSubscribe, and WorkloadManagement.

-l policyName

The name of the policy to report on.

-k application

The name of the application that contains the message flow.

-y library

The name of the library that contains the message flow.

-f policyDocument

The name of a file to write the retrieved policy to.

-a

Display as a single level list all policy (policy name and type only).

-r

Display all policy, and the contents of each policy.

Examples

Display all policies of type MQTTSubscribe for integration node IBNODE:

mqsireportpolicy IBNODE -t MQTTSubscribe -a

Write the contents of the default DataCapture policy to a file called DataCapturePolicyDocument.xml:

mqsireportpolicy IBNODE -t DataCapture -l default -f DataCapturePolicyDocument.xml