SSP Preferences

The Shared Storage Pool (SSP) PCM preference allows you to enable or disable the option for SSP PCM data collection and data Aggregation for one or more SSPs. The data collection for SSP is done by using the node or the virtual I/O server (VIOS) that are connected to the Hardware Management Console (HMC).

SSP has the following PCM preferences:
  • MonitorEnabled: Raw Metrics collection status
  • AggregationEnabled: Utilization data aggregation status
Note: When the Aggregation metrics is enabled, the Monitoring metrics is automatically enabled.

Resource

/rest/api/pcm/preferences/SSP
Table 1. Supported methods
Method Description Internet media type
GET This API is used to retrieve the preferences set for SSPs that are managed by the HMC. application/xml
POST This API is used to update the preferences set for SSPs that are managed by the HMC. application/xml

Resource

/rest/api/pcm/SSP/<SSPUuId>/preferences
Table 2. Supported methods
Method Description Internet media type
GET This API is used to retrieve the preferences set for a single SSP that is managed by the HMC. application/xml
POST This API is used to update the preferences set for a single SSP that is managedby the HMC. application/xml

GET Response 

/rest/api/pcm/preferences/SSP
<feed xmlns=http://www.w3.org/2005/Atom xmlns:ns2=http://a9.com/-/spec/opensearch/1.1/

          xmlns:ns3="http://www.w3.org/1999/xhtml">

	<id>FEED_UNIQUE_ID</id>

	<title type="text">Performance and Capacity Monitoring Preferences</title>

	<subtitle type="text"/>

	<link rel="self" href="https://HMC_IP_OR_HMC_HOST_NAME/rest/api/pcm/preferences/SSP"/>

	<generator uri="IBM Power Systems Management Console" version="1"/>

	<entry>

		<id>ENTRY_UNIQUE_ID</id>

		<updated>YYYY-MM-DDThh:mm:ss.sssZ</updated>

		<title type="text">Performance and Capacity Monitoring Preferences</title>

		<published>YYYY-MM-DDThh:mm:ss.sssZ</published>

		<author>

			<name>IBM Power Systems Management Console</name>

		</author>

		<content type="application/xml">

		<ManagementConsolePCMSSPPreference:ManagementConsolePCMSSPPreference xmlns:ManagementConsolePCM

               SSPPreference=http://www.ibm.com/xmlns/systems/power/firmware/pcm/mc/2012_10/

               xmlns=http://www.ibm.com/xmlns/systems/power/firmware/pcm/mc/2012_10/

               xmlns:ns2="http://www.w3.org/XML/1998/namespace/k2" schemaVersion="V1_5_1">

			<Metadata>

				<Atom/>

			</Metadata>

			<ManagementConsoleSSPPreference kb="UOD" kxe="false" schemaVersion="V1_5_1">

				<Metadata> 

				<Atom>

					<AtomID>SSP_UUID</AtomID>

					<AtomCreated>TIME in Milliseconds</AtomCreated>

				</Atom>

				</Metadata>

				<ClusterName kb="ROR" kxe="false">ClusterName</ClusterName>

				<ClusterUdId kxe="false" kb="ROR">ClusterUdId</ClusterUdId>

				<SSPName kb="ROR" kxe="false">SSPName</SSPName>

				<SSPUdId kxe="false" kb="ROR">SSPUdid</SSPUdId>

				<SSPUuId kb="ROR" kxe="false">SSPUuId</SSPUuId>

				<AggregationEnabled kxe="false" kb="UOD">true/false</AggregationEnabled>

				<MonitorEnabled kb="UOD" kxe="false">true/false</MonitorEnabled>

				<RemoteHMCCollectionStatus kb="ROR" kxe="false">true/false</RemoteHMCCollectionStatus>

				<AssociatedSharedStoragePool kxe="false" kb="ROR" href="https://HMC_IP_OR_HMC_HOST_NAME:

                             443/rest/api/uom/SharedStoragePool/SSP UUID" rel="related"/>

				<ManagedNodeSSPPreferences kb="ROR" kxe="false" schemaVersion="V1_5_1">

					<Metadata>

						<Atom/>

					</Metadata>

					<NodeMTMS kxe="false" kb="ROR">NodeMTMS</NodeMTMS>

					<NodeCollectionStatus kxe="false" kb="ROR">On/Off</NodeCollectionStatus>

					<NodeName kxe="false" kb="ROR">NodeName</NodeName>

					<NodeId kxe="false" kb="ROR">NodeId</NodeId>

					<NodeIPAddress kb="ROR" kxe="false">NodeIPAddress</NodeIPAddress>

				</ManagedNodeSSPPreferences>

			</ManagementConsoleSSPPreference>

		</ManagementConsolePCMSSPPreference:ManagementConsolePCMSSPPreference>

		</content>

	</entry>

</feed>

Successful execution of the request is returned with response code 200. In response, the application returns the following repeating attributes based on the number of SSPs, and the node or VIOS that are configured.

  • ManagementConsoleSSPPreference: The SSP level preferences
    • AtomId: UUID of the SSP
    • AtomCreated: Creation time of the feed in milliseconds
    • ClusterName: Name of the cluster
    • ClusterUUID: A unique ID that is associated with the cluster
    • SSPName: Name of the SSP
    • SSPUDID: Unique ID of SSP from VIOS
    • SSPUUID: The UUID of SSP, this ID is used for further references
    • AggregationEnabled: This attribute indicates whether an Aggregation is enabled or not
    • MonitorEnabled: This attribute indicates whether any Collection is enabled or not
    • RemoteHMCCollectionStatus: This field indicates whether a different HMC is collecting the SSP data
    • AssociatedSharedStoragePool: Unique REST URI for the SSP
    • ManagedNodeSSPPreferences: The Node or VIOS that are connected to the HMC.
      • NodeMTMS: The MTMS of the Node or VIOS
      • NodeCollectionStatus: This attribute indicates whether the collection is enabled through this node
      • NodeName: Name of the Node or VIOS
      • NodeId: The ID of the Node in the SSP pool.
      • NodeIPAddress: IP address of the pool.
      Timestamp of the last available Aggregated metrics data

The ManagementConsoleSSPPreference properties repeat for every SSP that the HMC is managing.

The ManagedNodeSSPPreferences properties repeat for every connected Node or VIOS that is a part of the SSP.

/rest/api/pcm/SSP/SSPUuId/preferences
<feed xmlns=http://www.w3.org/2005/Atom xmlns:ns2=http://a9.com/-/spec/opensearch/1.1/

             xmlns:ns3="http://www.w3.org/1999/xhtml">

	<id>FEED_UNIQUE_ID</id>

	<title type="text">Performance and Capacity Monitoring Preferences</title>

	<subtitle type="text"/>

	<link rel="self" href="https://HMC_IP_OR_HMC_HOST_NAME/rest/api/pcm/preferences/SSP"/>

	<generator uri="IBM Power Systems Management Console" version="1"/>

	<entry>

		<id>ENTRY_UNIQUE_ID</id>

		<updated>YYYY-MM-DDThh:mm:ss.sssZ</updated>

		<title type="text">Performance and Capacity Monitoring Preferences</title>

		<published>YYYY-MM-DDThh:mm:ss.sssZ</published>

		<author>

			<name>IBM Power Systems Management Console</name>

		</author>

		<content type="application/xml">

			<ManagementConsoleSSPPreference:ManagementConsoleSSPPreference 

                     xmlns:ManagementConsoleSSPPreference="http://www.ibm.com/xmlns/systems/power/firmware/

                     pcm/mc/2012_10/"

                     xmlns="http://www.ibm.com/xmlns/systems/power/firmware/pcm/mc/2012_10/"

                     xmlns:ns2="http://www.w3.org/XML/1998/namespace/k2" schemaVersion="V1_6_0">

				<Metadata> 

					<Atom>

						<AtomID>SSP_UUID</AtomID>

						<AtomCreated>TIME in Milliseconds</AtomCreated>

					</Atom>

				</Metadata>

				<ClusterName kb="ROR" kxe="false">ClusterName</ClusterName>

				<ClusterUdId kxe="false" kb="ROR">ClusterUdId</ClusterUdId>

				<SSPName kb="ROR" kxe="false">SSPName</SSPName>

				<SSPUdId kxe="false" kb="ROR">SSPUdid</SSPUdId>

				<SSPUuId kb="ROR" kxe="false">SSPUuId</SSPUuId>

				<AggregationEnabled kxe="false" kb="UOD">true/false</AggregationEnabled>

				<MonitorEnabled kb="UOD" kxe="false">true/false</MonitorEnabled>

				<RemoteHMCCollectionStatus kb="ROR" kxe="false">true/false</RemoteHMCCollectionStatus>

				<AssociatedSharedStoragePool kxe="false" kb="ROR" href="https://HMC_IP_OR_HMC_HOST_NAME:

                            443/rest/api/uom/SharedStoragePool/SSP UUID" rel="related"/>

				<ManagedNodeSSPPreferences kb="ROR" kxe="false" schemaVersion="V1_5_1">

					<Metadata>

						<Atom/>

					</Metadata>

					<NodeMTMS kxe="false" kb="ROR">NodeMTMS</NodeMTMS>

					<NodeCollectionStatus kxe="false" kb="ROR">On/Off</NodeCollectionStatus>

					<NodeName kxe="false" kb="ROR">NodeName</NodeName>

					<NodeId kxe="false" kb="ROR">NodeId</NodeId>

					<NodeIPAddress kb="ROR" kxe="false">NodeIPAddress</NodeIPAddress>

				</ManagedNodeSSPPreferences>

			</ManagementConsoleSSPPreference:ManagementConsoleSSPPreference>

		</content>

	</entry>

</feed>

Sample payload for POST request

User can update only the AggregationEnabled and MonitorEnabled attributes. All the other attributes are read-only.

/rest/api/pcm/preferences/SSP
<ManagementConsolePCMSSPPreference:ManagementConsolePCMSSPPreference

             xmlns:ManagementConsolePCMSSPPreference=http://www.ibm.com/xmlns/systems/power/firmware/

             pcm/mc/2012_10/

             xmlns=http://www.ibm.com/xmlns/systems/power/firmware/pcm/mc/2012_10/

             xmlns:ns2="http://www.w3.org/XML/1998/namespace/k2" schemaVersion="V1_5_1">

	<Metadata>

		<Atom/>

	</Metadata>

	<ManagementConsoleSSPPreference kb="UOD" kxe="false" schemaVersion="V1_5_1">

		<Metadata> 

			<Atom>

				<AtomID>SSP_UUID</AtomID>

				<AtomCreated>TIME in Milliseconds</AtomCreated>

			</Atom>

		</Metadata>

		<ClusterName kb="ROR" kxe="false">ClusterName</ClusterName>

		<ClusterUdId kxe="false" kb="ROR">ClusterUdId</ClusterUdId>

		<SSPName kb="ROR" kxe="false">SSPName</SSPName>

		<SSPUdId kxe="false" kb="ROR">SSPUdid</SSPUdId>

		<SSPUuId kb="ROR" kxe="false">SSPUuId</SSPUuId>

		<AggregationEnabled kxe="false" kb="UOD">true/false</AggregationEnabled>

		<MonitorEnabled kb="UOD" kxe="false">true/false</MonitorEnabled>

		<RemoteHMCCollectionStatus kb="ROR" kxe="false">true/false</RemoteHMCCollectionStatus>

		<AssociatedSharedStoragePool kxe="false" kb="ROR" href="https://HMC_IP_OR_HMC_HOST_NAME:

              443/rest/api/uom/SharedStoragePool/SSP UUID" rel="related"/>

		<ManagedNodeSSPPreferences kb="ROR" kxe="false" schemaVersion="V1_5_1">

			<Metadata>

				<Atom/>

			</Metadata>

			<NodeMTMS kxe="false" kb="ROR">NodeMTMS</NodeMTMS>

			<NodeCollectionStatus kxe="false" kb="ROR">On/Off</NodeCollectionStatus>

			<NodeName kxe="false" kb="ROR">NodeName</NodeName>

			<NodeId kxe="false" kb="ROR">NodeId</NodeId>

			<NodeIPAddress kb="ROR" kxe="false">NodeIPAddress</NodeIPAddress>				

		</ManagedNodeSSPPreferences>

	</ManagementConsoleSSPPreference>

</ManagementConsolePCMSSPPreference:ManagementConsolePCMSSPPreference>
/rest/api/pcm/SSP/<SSPUuId>/preferences
<ManagementConsoleSSPPreference:ManagementConsoleSSPPreference xmlns:ManagementConsole

             SSPPreference="http://www.ibm.com/xmlns/systems/power/firmware/pcm/mc/2012_10/"

             xmlns="http://www.ibm.com/xmlns/systems/power/firmware/pcm/mc/2012_10/"

             xmlns:ns2="http://www.w3.org/XML/1998/namespace/k2" schemaVersion="V1_6_0">

	<Metadata> 

		<Atom>

			<AtomID>SSP_UUID</AtomID>

			<AtomCreated>TIME in Milliseconds</AtomCreated>

		</Atom>

	</Metadata>

	<ClusterName kb="ROR" kxe="false">ClusterName</ClusterName>

	<ClusterUdId kxe="false" kb="ROR">ClusterUdId</ClusterUdId>

	<SSPName kb="ROR" kxe="false">SSPName</SSPName>

	<SSPUdId kxe="false" kb="ROR">SSPUdid</SSPUdId>

	<SSPUuId kb="ROR" kxe="false">SSPUuId</SSPUuId>

	<AggregationEnabled kxe="false" kb="UOD">true/false</AggregationEnabled>

	<MonitorEnabled kb="UOD" kxe="false">true/false</MonitorEnabled>

	<RemoteHMCCollectionStatus kb="ROR" kxe="false">true/false</RemoteHMCCollectionStatus>

	<AssociatedSharedStoragePool kxe="false" kb="ROR" href="https://HMC_IP_OR_HMC_HOST_NAME:

        443/rest/api/uom/SharedStoragePool/SSP UUID" rel="related"/>

	<ManagedNodeSSPPreferences kb="ROR" kxe="false" schemaVersion="V1_5_1">

		<Metadata>

			<Atom/>

		</Metadata>

		<NodeMTMS kxe="false" kb="ROR">NodeMTMS</NodeMTMS>

		<NodeCollectionStatus kxe="false" kb="ROR">On/Off</NodeCollectionStatus>

		<NodeName kxe="false" kb="ROR">NodeName</NodeName>

		<NodeId kxe="false" kb="ROR">NodeId</NodeId>

		<NodeIPAddress kb="ROR" kxe="false">NodeIPAddress</NodeIPAddress>

	</ManagedNodeSSPPreferences>

</ManagementConsoleSSPPreference:ManagementConsoleSSPPreference>
Parent topic: Shared Storage Pool Monitoring


Last updated: Fri, June 23, 2017