Cisco UCS Manager XML API Programmers Guide

First Published: April 21, 2011

Last Modified: May 26, 2011
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Text Part Number: OL-20038-03

2014 Cisco Systems, Inc. All rights reserved.

C ONT E NT S
P r e f a c e Preface vii
Audience vii
Conventions vii
Related Cisco UCS Documentation ix
Documentation Feedback ix
C H A P T E R 1 1
Cisco UCS Management Information Model 1
Sample Flow 1
Object Naming 2
API Method Categories 2
Authentication Methods 2
Query Methods 3
Configuration Methods 3
Event Subscription Methods 4
Success or Failure Response 4
Successful Response 4
Failed Requests 4
Empty Results 4
C H A P T E R 2 Using the Methods 7
Authentication Methods 7
Login 7
Refreshing the Session 8
Logging Out of the Session 8
Unsuccessful Responses 8
Query Methods 9
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 iii
Using configResolveChildren 9
Using configResolveClass 9
Using configResolveDn 9
Using configResolveParent 10
C H A P T E R 3 Method Descriptions 11
aaaGetComputeAuthTokens 11
aaaKeepAlive 12
aaaLogin 13
aaaLogout 13
aaaRefresh 14
configConfMo 14
configResolveChildren 15
configResolveClass 15
configResolveDn 16
configResolveParent 16
eventSubscribe 17
eventUnsubscribe 17
C H A P T E R 4 XML Object-Access Privileges 19
Privileges Summary Table 19
Privileges 19
aaa 19
admin 20
ext-lan-config 20
ext-lan-policy 20
ext-lan-qos 21
ext-lan-security 21
ext-san-config 21
ext-san-policy 22
ext-san-qos 22
ext-san-security 22
fault 22
ls-config 23
ls-config-policy 23
Cisco UCS Manager XML API Programmers Guide
iv OL-20038-03
Contents
ls-ext-access 24
ls-network 24
ls-network-policy 24
ls-power 25
ls-qos 25
ls-qos-policy 25
ls-security 26
ls-security-policy 26
ls-server 26
ls-server-oper 27
ls-server-policy 27
ls-storage 28
ls-storage-policy 28
operations 28
pn-equipment 29
pn-maintenance 29
pn-policy 30
pn-security 30
pod-config 31
pod-policy 31
pod-qos 31
pod-security 31
power-mgmt 32
read-only 32
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 v
Contents
Cisco UCS Manager XML API Programmers Guide
vi OL-20038-03
Contents
Preface
This preface includes the following sections:
Audience, page vii
Conventions, page vii
Related Cisco UCS Documentation, page ix
Documentation Feedback, page ix
Audience
This guide is intended primarily for data center administrators with responsibilities and expertise in one or
more of the following:
Server administration
Storage administration
Network administration
Network security
Conventions
Indication Text Type
GUI elements such as tab titles, area names, and field labels appear in this font.
Main titles such as window, dialog box, and wizard titles appear in this font.
GUI elements
Document titles appear in this font. Document titles
In a Text-based User Interface, text the systemdisplays appears in this font. TUI elements
Terminal sessions and information that the system displays appear in this
font.
System output
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 vii
Indication Text Type
CLI command keywords appear in this font.
Variables in a CLI command appear in this font.
CLI commands
Elements in square brackets are optional. [ ]
Required alternative keywords are grouped in braces and separated by vertical
bars.
{x | y | z}
Optional alternative keywords are grouped in brackets and separated by vertical
bars.
[x | y | z]
A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
string
Nonprinting characters such as passwords are in angle brackets. < >
Default responses to system prompts are in square brackets. [ ]
An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
!, #
Means reader take note. Notes contain helpful suggestions or references to material not covered in the
document.
Note
Means the following information will help you solve a problem. The tips information might not be
troubleshooting or even an action, but could be useful information, similar to a Timesaver.
Tip
Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.
Caution
Means the described action saves time. You can save time by performing the action described in the
paragraph.
Timesaver
Cisco UCS Manager XML API Programmers Guide
viii OL-20038-03
Preface
Conventions
IMPORTANT SAFETY INSTRUCTIONS
This warning symbol means danger. You are in a situation that could cause bodily injury. Before you
work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with
standard practices for preventing accidents. Use the statement number provided at the end of each warning
to locate its translation in the translated safety warnings that accompanied this device.
SAVE THESE INSTRUCTIONS
Warning
Related Cisco UCS Documentation
Documentation Roadmaps
For a complete list of all B-Series documentation, see the Cisco UCS B-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/b-series-doc.
For a complete list of all C-Series documentation, see the Cisco UCS C-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/c-series-doc.
Other Documentation Resources
An ISOfile containing all Band C-Series documents is available at the following URL: http://www.cisco.com/
cisco/software/type.html?mdfid=283853163&flowid=25821. From this page, click Unified Computing
System (UCS) Documentation Roadmap Bundle.
The ISO file is updated after every major documentation release.
Follow Cisco UCS Docs on Twitter to receive document update notifications.
Documentation Feedback
To provide technical feedback on this document, or to report an error or omission, please send your comments
to [email protected]. We appreciate your feedback.
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 ix
Preface
Related Cisco UCS Documentation
Cisco UCS Manager XML API Programmers Guide
x OL-20038-03
Preface
Documentation Feedback
C HAP T E R 1
This chapter includes the following sections:
Cisco UCS Management Information Model, page 1
Sample Flow, page 1
Object Naming, page 2
API Method Categories, page 2
Success or Failure Response, page 4
Cisco UCS Management Information Model
All the physical and logical components that comprise Cisco UCS are represented in a hierarchical management
information model, referred to as the MIT. Each node in the tree represents a managed object (MO) or group
of objects that contains its administrative state and its operational state.
The hierarchical structure starts at the top (sys) and contains parent and child nodes. Each node in this tree
is a managed object and each object in Cisco UCS has a unique distinguished name (DN) that describes the
object and its place in the tree. Managed objects are abstractions of the Cisco UCS resources, such as .
Configuration policies are the majority of the policies in the systemand describe the configurations of different
Cisco UCS components. Policies determine how the system behaves under specific circumstances. Certain
managed objects are not created by users, but are automatically created by the Cisco UCS, for example, power
supply objects and fan objects. By invoking the API, you are reading and writing objects to the management
information model (MIM).
Sample Flow
A typical request comes into and is placed in the transactor queue in FIFO order. The transactor gets the
request from the queue, interprets the request, and performs an authorization check. After the request is
confirmed, the transactor updates the management information tree. This operation is done in a single
transaction.
The following figure shows how processes a boot server request. The following table describes the steps
involved in a boot server request.
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 1
Object Naming
You can identify a specific object by its distinguished name (DN) or by its relative name (RN).
Distinguished Name
The distinguished name enables you to unambiguously identify a target object. The distinguished name has
the following format consisting of a series of relative names:
dn = {rn}/{rn}/{rn}/{rn}...
In the following example, the DN provides a fully qualified path for adaptor-1 from the top of the object tree
to the object. The DN specifies the exact managed object on which the API call is operating.
< dn =sys/adaptor-1 />
Relative Name
The relative name identifies an object within the context of its parent object. The distinguished name is
composed of a sequence of relative names.
For example, this distinguished name:
<dn = "sys/adaptor-1/host-eth-2"/>
is composed of the following relative names:
API Method Categories
Each method corresponds to an XML document.
Several code examples in this guide substitute the term <real_cookie> for an actual cookie (such as
1217377205/85f7ff49-e4ec-42fc-9437-da77a1a2c4bf). The XML API cookie is a 47-character string; it
is not the type of cookie that web browsers store locally to maintain session information.
Note
Authentication Methods
Authentication methods authenticate and maintain the session. For example:
aaaLoginInitial method for logging in.
aaaRefreshRefreshes the current authentication cookie.
aaaLogoutExits the current session and deactivates the corresponding authentication cookie.
Use the aaaLogin method to get a valid cookie. Use aaaRefresh to maintain the session and keep the cookie
active. Use the aaaLogout method to terminate the session (also invalidates the cookie). A maximum of
sessions to the Cisco UCS can be opened at any one time.
Cisco UCS Manager XML API Programmers Guide
2 OL-20038-03
Object Naming
Operations are performed using the HTTP post method ( supports both HTTP and HTTPS requests) over
TCP. HTTP and HTTPS can be configured to use different port numbers, but TCP/443 (or TCP/80 for
non-secure connections) is used by default. The HTTP envelope contains the XML configuration.
In CIMC, HTTP to HTTPS redirection is enabled by default. To capture HTTP packets between the client
application and CIMC, disable redirection in the CIMC GUI or CLI.
Tip
Query Methods
Query methods obtain information on the current configuration state of an object. The following are query :
configResolveDnRetrieves objects by DN.
configResolveClassRetrieves objects of a given class.
configResolveChildrenRetrieves the child objects of an object.
configResolveParentRetrieves the parent object of an object.
Most query methods have the argument inHierarchical (Boolean true/yes or false/no). If true, the inHierarchical
argument returns all child objects.
<configResolveDn inHierarchical="false"></>
<configResolveDn inHierarchical="true"></>
Because the amount of data returned from can be quite large, the inHierarchical argument should be used with
care. For example, if the query method is used on a class or DN that refers to a managed object (MO) that is
located high on the management information tree and inHierarchical is set to true, the response can contain
almost the entire configuration. The resources required for to process the request can be high, causing to take
an extended amount of time to respond. To avoid delays, the query method should be performed on a smaller
scale involving fewer MOs.
If a query method does not respond or is taking a long time to respond, increase the timeout period on the
client application or adjust the query method to involve fewer MOs.
Tip
The query API methods might also have an inRecursive argument to specify whether the call should be
recursive (for example, follow objects that point back to other objects or the parent object).
Until a host is powered on at least once, may not have complete inventory and status information. For
example, if is reset, it will not have detailed CPU, memory, or adapter inventory information until the
next time the host is powered on. If a query method is performed on a MOcorresponding to the unavailable
data, the response will be blank.
Note
Configuration Methods
configConfMoAffects a single managed object (for example, a DN).
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 3
Query Methods
Event Subscription Methods
Applications get state change information by regular polling or event subscription. For more efficient use of
resources, event subscription is the preferred method of notification. Polling should be used only under very
limited circumstances.
Use eventSubscribe to register for events, as shown the following example:
<eventSubscribe
cookie="<real_cookie>">
</eventSubscribe>
To receive notifications, open an HTTP or HTTPS session over TCP and keep the session open. On receiving
eventSubscribe, starts sending all new events as they occur. You can unsubscribe from these events using the
eventUnsubscribe method.
Each event has a unique event ID. Event IDs operate as counters and are included in all method responses.
When an event is generated, the event ID counter increments and is assigned as the new event ID. This
sequential numbering enables tracking of events and ensures that no event is missed.
An event channel connection opened by a user will be closed automatically by after 600 seconds of inactivity
associated with the event channel session cookie. To prevent automatic closing of the event channel connection
by , the user must either send the aaaKeepAlive request for the same event channel session cookie within 600
seconds or send any other XML API method to using the same event channel session cookie.
Success or Failure Response
When responds to an XML API request, the response indicates failure if the request is impossible to complete.
A successful response indicates only that the request is valid, not that the operation is complete. For example,
it may take some time for a server to finish a power-on request. The power state changes from down to up
only after the server actually powers on.
Successful Response
When a request has executed successfully, returns an XML document with the information requested or a
confirmation that the changes were made. The following is an example of a configResolveDn query on the
distinguished name :
The response includes the following information:
Failed Requests
The response to a failed request includes XML attributes for errorCode and errorDescr. The following is an
example of a response to a failed request:
Empty Results
A query request for a nonexistent object is not treated as a failure by . If the object does not exist, returns a
success message, but the XML document contains an empty data field (<outConfig> </outConfig>) to
Cisco UCS Manager XML API Programmers Guide
4 OL-20038-03
Event Subscription Methods
indicate that the requested object was not found. The following example shows the response to an attempt to
resolve the distinguished name on a nonexistent rack-mount server:
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 5
Empty Results
Cisco UCS Manager XML API Programmers Guide
6 OL-20038-03
Empty Results
C HAP T E R 2
Using the Methods
This chapter includes the following sections:
Authentication Methods, page 7
Query Methods, page 9
Authentication Methods
Authentication allows XML API interaction with the . It provides a way to set permissions and control the
operations that can be performed.
Most code examples in this guide substitute the term <real_cookie> for an actual cookie (such as
1217377205/85f7ff49-e4ec-42fc-9437-da77a1a2c4bf). The Cisco UCS cookie is a 47-character string; it
is not the type of cookie that web browsers store locally to maintain session information.
Note
Login
To log in, the XML API client establishes a TCP connection to the HTTP (or HTTPS) server and posts an
XML document containing the aaaLogin method.
In the following example, the Telnet utility is used to establish a TCP connection to port 80 of the with IP
address 192.0.20.72. The path used is /nuova.
$ telnet 192.0.20.72 80
POST /nuova HTTP/1.1
USER-Agent: lwp-request/2.06
HOST: 192.0.20.72
Content-Length: 62
Content-Type: application/x-www-form-urlencoded
Next, the client specifies the aaaLogin method and provides a user name and password:
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 7
Do not include XML version or DOCTYPE lines in the XML API document. The inName and inPassword
attributes are parameters.
Note
Each XML API document represents an operation to be performed. When the request is received as an XML
API document, reads the request and performs the actions as provided in the method. responds with a message
in XML document format and indicates success or failure of the request.
The following is a typical successful response:
Each line in the response should be interpreted as follows:
1 Specifies the method used to login.
2 Confirms that this is a response.
3 Provides the session cookie.
4 Specifies the recommended cookie refresh period. The default login session length is 600 seconds.
5 Specifies the privilege level assigned to the user account.
6 Closing tag.
Alternatively, you can use the cURL utility to log in to the XML API, as shown in the following example:
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" http://192.0.20.72/nuova
If HTTPS is enabled, you must use HTTPS in the cURL command, as shown in the following example:
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" https://192.0.20.72/nuova
Refreshing the Session
Sessions are refreshed with the aaaRefresh method, using the 47-character cookie obtained either from the
aaaLogin response or a previous refresh.
Logging Out of the Session
Use the following method to log out of a session:
Unsuccessful Responses
Failed login:
Nonexistent object (blank return indicates no object with the specified DN):
Bad request:
Cisco UCS Manager XML API Programmers Guide
8 OL-20038-03
Using the Methods
Refreshing the Session
Query Methods
Using configResolveChildren
When resolving children of objects in the MIT, note the following:
This method obtains all child objects of a named object that are instances of the named class. If a class
name is omitted, all child objects of the named object are returned.
inDn attribute specifies the named object from which the child objects are retrieved (required).
classId attribute specifies the name of the child object class to return (optional).
Authentication cookie (from aaaLogin or aaaRefresh) is required.
inHierarchical attribute (default = false) if true, specifies that results are hierarchical.
Enumerated values, classIds, and bit masks are displayed as strings.
See the example request/response in configResolveChildren, on page 15.
Using configResolveClass
When resolving a class, note the following:
All objects of the specified class type are retrieved.
classId specifies the object class name to return (required).
Authentication cookie (from aaaLogin or aaaRefresh) is required.
inHierarchical attribute (default = false) if true, specifies that results are hierarchical.
Enumerated values, classIds, and bit masks are displayed as strings.
<configResolveClass
cookie="real_cookie"
inHierarchical="false"
classId=""/>
See the example request/response in configResolveClass, on page 15.
Using configResolveDn
When resolving a DN, note the following:
The object specified by the DN is retrieved.
Specified DN identifies the object instance to be resolved (required).
Authentication cookie (from aaaLogin or aaaRefresh) is required.
inHierarchical attribute (default = false) if true, specifies that results are hierarchical.
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 9
Using the Methods
Query Methods
Enumerated values, classIds, and bit masks are displayed as strings.
See the example request/response in configResolveDn, on page 16.
Using configResolveParent
When resolving the parent object of an object, note the following:
This method retrieves the parent object of a specified DN.
dn attribute is the DN of the child object (required).
Authentication cookie (from aaaLogin or aaaRefresh) is required.
inHierarchical attribute (default = false) if true, specifies that results are hierarchical.
Enumerated values, classIds, and bit masks are displayed as strings.
See the example request/response in configResolveParent, on page 16.
Cisco UCS Manager XML API Programmers Guide
10 OL-20038-03
Using the Methods
Using configResolveParent
C HAP T E R 3
Method Descriptions
This chapter includes the following sections:
aaaGetComputeAuthTokens, page 11
aaaKeepAlive, page 12
aaaLogin, page 13
aaaLogout, page 13
aaaRefresh, page 14
configConfMo, page 14
configResolveChildren, page 15
configResolveClass, page 15
configResolveDn, page 16
configResolveParent, page 16
eventSubscribe, page 17
eventUnsubscribe, page 17
aaaGetComputeAuthTokens
The aaaGetComputeAuthTokens method returns authentication tokens that are used to launch the KVM. This
generates two temporary authentication tokens that are valid for 60 seconds. The first is the KVM user name
and the second token is the password. Using the authorization tokens as credentials, you can access the URL
from where you can download the Java Network Launch Protocol (JNLP) file. You can download the JNLP
file from the URL and launch it to start a KVM session.
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 11
Note You cannot obtain tokens if the vKVM option is disabled on the CIMC.
You must have user or admin privileges to the CIMC to obtain the authentication tokens. Users with
read-only privileges will not be able to obtain the tokens.
The authorization tokens expire is 60 seconds; you cannot use the tokens after 60 seconds to access
the URL. If you try to access after 60 seconds, the login fails and you get a authentication failure or
timeout message.
Request Syntax
<xs:element name="aaaGetComputeAuthTokens" type="aaaGetComputeAuthTokens"
substitutionGroup="externalMethod"/>
<xs:complexType name="aaaGetComputeAuthTokens" mixed="true">
<xs:attribute name="cookie" type="stringMin0Max47" use="required"/>
<xs:attribute name="response" type="YesOrNo"/>
</xs:complexType>
Response Syntax
<xs:element name="aaaGetComputeAuthTokens" type="aaaGetComputeAuthTokens"
substitutionGroup="externalMethod"/>
<xs:complexType name="aaaGetComputeAuthTokens" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="outTokens">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="0"/>
<xs:maxLength value="510"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
Examples
Request:
<aaaGetComputeAuthTokens
cookie="<real_cookie>" />'
Response:
<aaaGetComputeAuthTokens
cookie="<real_cookie>
outTokens="1957747793,424238335"
response="yes">
</aaaGetComputeAuthTokens>
aaaKeepAlive
The aaaKeepAlive method keeps the session active until the default session time expires, using the same
cookie after the method call.
Cisco UCS Manager XML API Programmers Guide
12 OL-20038-03
Method Descriptions
aaaKeepAlive
Request Syntax
Response Syntax
<xs:element name="aaaKeepAlive" type="aaaKeepAlive" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaKeepAlive" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>
Examples
Request
Response
aaaLogin
The aaaLogin method is the login process and is required to begin a session. This action establishes the HTTP
(or HTTPS) session between the client and .
Request Syntax
Response Syntax
Examples
Request
Response
aaaLogout
The aaaLogout method is a process to close a web session by passing the session cookie as input. It is not
automatic; the user has to explicitly invoke the aaaLogout method to terminate the session.
Request Syntax
Response Syntax
<xs:element name="aaaLogout" type="aaaLogout" substitutionGroup="externalMethod"/>
<xs:complexType name="aaaLogout" mixed="true">
<xs:attribute name="outStatus">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="success"/>
<xs:enumeration value="failure"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="cookie" type="xs:string"/>
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 13
Method Descriptions
aaaLogin
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>
Examples
Request
Response
aaaRefresh
The aaaRefresh method keeps sessions active (within the default session time frame) by user activity. There
is a default of 600 seconds that counts down when inactivity begins. If the 600 seconds expire, enters a sleep
mode. It requires signing back in, which restarts the countdown. It continues using the same session ID.
Using this method expires the previous cookie and issues a new cookie. Note
Request Syntax
Response Syntax
Examples
Request
Response
configConfMo
The configConfMo method configures the specified managed object in a single subtree (for example, DN).
Request Syntax
Response Syntax
<xs:element name="configConfMo" type="configConfMo" substitutionGroup="externalMethod"/>
<xs:complexType name="configConfMo" mixed="true">
<xs:all>
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
</xs:complexType>
Cisco UCS Manager XML API Programmers Guide
14 OL-20038-03
Method Descriptions
aaaRefresh
Examples
Request
Response
configResolveChildren
The configResolveChildren method retrieves children of managed objects under a specific DNin the managed
information tree.
Request Syntax
Response Syntax
<xs:element name="configResolveChildren" type="configResolveChildren"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveChildren" mixed="true">
<xs:all>
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="classId" type="namingClassId"/>
</xs:complexType>
Examples
Request
Response
configResolveClass
The configResolveClass method returns requested managed object in a given class. If inHierarchical=true,
the results contain children.
Request Syntax
Response Syntax
<xs:element name="configResolveClass" type="configResolveClass"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveClass" mixed="true">
<xs:all>
<xs:element name="outConfigs" type="configSet" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="classId" type="namingClassId"/>
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 15
Method Descriptions
configResolveChildren
</xs:complexType>
Examples
Request
Response
configResolveDn
The configResolveDn method retrieves a single managed object for a specified DN.
Request Syntax
Response Syntax
<xs:element name="configResolveDn" type="configResolveDn"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveDn" mixed="true">
<xs:all>
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
<xs:attribute name="dn" type="referenceObject"/>
</xs:complexType>
Examples
Request
Response
configResolveParent
For a specified DN, the configResolveParent method retrieves the parent of the managed object.
Request Syntax
Response Syntax
<xs:element name="configResolveParent" type="configResolveParent"
substitutionGroup="externalMethod"/>
<xs:complexType name="configResolveParent" mixed="true">
<xs:all>
<xs:element name="outConfig" type="configConfig" minOccurs="0"/>
</xs:all>
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
Cisco UCS Manager XML API Programmers Guide
16 OL-20038-03
Method Descriptions
configResolveDn
<xs:attribute name="dn" type="referenceObject"/>
</xs:complexType>
Examples
Request
Response
eventSubscribe
Event subscription allows a client application to register for event notification from . When an event occurs,
informs the client application of the event and its type. Only the actual change information is sent. The objects
unaffected attributes are not included.
Use eventSubscribe to register for events as shown in the following example:
<eventSubscribe
cookie="<real_cookie>">
</eventSubscribe>
Request Syntax
Response Syntax
<xs:element name="eventSubscribe" type="eventSubscribe"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventSubscribe" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>
Examples
Request
Response
NO RESPONSE OR ACKNOWLEDGMENT.
eventUnsubscribe
Use eventUnsubscribe to unsubscribe from events as shown in the following example:
<eventUnsubscribe
cookie="<real_cookie>">
</eventUnsubscribe>
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 17
Method Descriptions
eventSubscribe
Request Syntax
Response Syntax
<xs:element name="eventUnsubscribe" type="eventUnsubscribe"
substitutionGroup="externalMethod"/>
<xs:complexType name="eventUnsubscribe" mixed="true">
<xs:attribute name="cookie" type="xs:string"/>
<xs:attribute name="response" type="YesOrNo"/>
<xs:attribute name="errorCode" type="xs:unsignedInt"/>
<xs:attribute name="errorDescr" type="xs:string"/>
<xs:attribute name="invocationResult" type="xs:string"/>
</xs:complexType>
Examples
Request
Response
NO RESPONSE OR ACKNOWLEDGMENT.
Cisco UCS Manager XML API Programmers Guide
18 OL-20038-03
Method Descriptions
eventUnsubscribe
C HAP T E R 4
XML Object-Access Privileges
This chapter includes the following sections:
Privileges Summary Table, page 19
Privileges, page 19
Privileges Summary Table
When users are assigned to a role, that role allows certain privileges. Those privileges allow the user access
to specific system resources and authorize permission to perform tasks on those resources. The following
table lists each privilege and the initial default user role that has been given that privilege.
Privileges
aaa
Purpose
System security and AAA.
This privilege has read and write access to all users, roles, AAA, and communication services configuration.
Read access is available for all other objects.
Responsible Role
AAA Administrator
Controlled Objects
aaa:AuthRealm, aaa:EpAuthProfile, aaa:EpUser, aaa:ExtMgmtCutThruTkn, aaa:LdapEp, aaa:LdapProvider,
aaa:Locale, aaa:Log, aaa:Org, aaa:RadiusEp, aaa:RadiusProvider, aaa:RemoteUser, aaa:Role, aaa:Session,
aaa:SshAuth, aaa:TacacsPlusEp, aaa:TacacsPlusProvider, aaa:User, aaa:UserEp, aaa:UserLocale, aaa:UserRole,
comm:Cimxml, comm:Dns, comm:DnsProvider, comm:EvtChannel, comm:Http, comm:Https,
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 19
comm:SmashCLP, comm:Snmp, comm:SnmpTrap, comm:SnmpUser, comm:Ssh, comm:SvcEp, comm:Telnet,
comm:WebChannel, comm:Wsman, comm:XmlClConnPolicy, comm:XmlClConnPolicy, pki:CertReq,
pki:KeyRing, pki:TP
admin
Purpose
System administration
Responsible Role
Administrator
Controlled Objects
This role is system level. The administrator controls all objects.
ext-lan-config
Purpose
External LAN configuration
Responsible Role
Network Administrator
Controlled Objects
adaptor:ExtIf, adaptor:ExtEthIf, adaptor:HostIf, adaptor:HostEthIf, adaptor:HostFcIf, comm:DateTime,
comm:Dns, comm:DnsProvider, comm:NtpProvider, fabric:EthLan, fabric:EthLanEp, fabric:EthLanPc,
fabric:EthLanPcEp, fabric:LanCloud, fabric:LanPinGroup, fabric:LanPinTarget, fabric:Vlan, macpool:Format,
network:Element, top:System, vnic:FcOEIf, vnic:LanConnTempl
ext-lan-policy
Purpose
External LAN policy
Responsible Role
Network Administrator
Controlled Objects
adaptor:ExtIf, adaptor:ExtEthIf, adaptor:HostIf, adaptor:HostEthIf, adaptor:HostFcIf, fabric:EthLan,
fabric:EthLanEp, fabric:EthLanPc, fabric:EthLanPcEp, fabric:LanCloud, fabric:LanPinGroup,
Cisco UCS Manager XML API Programmers Guide
20 OL-20038-03
XML Object-Access Privileges
admin
fabric:LanPinTarget, fabric:VCon, fabric:VConProfile, fabric:Vlan, macpool:Format, vnic:FcOEIf,
vnic:LanConnTempl
ext-lan-qos
Purpose
External LAN QoS
Responsible Role
Network Administrator
Controlled Objects
qosclass:Definition, qosclass:EthBE, qosclass:EthClassified, qosclass:Fc
ext-lan-security
Purpose
External LAN security
Responsible Role
Network Administrator
Controlled Objects
comm:DateTime, comm:NtpProvider
ext-san-config
Purpose
External SAN configuration
Responsible Role
Storage Administrator
Controlled Objects
fabric:FcSan, fabric:FcSanEp, fabric:FcSanPc, fabric:FcSanPcEp, fabric:FcVsanPortEp, fabric:SanPinGroup,
fabric:SanPinTarget, fabric:Vsan, fcpool:Format, vnic:FcOEIf
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 21
XML Object-Access Privileges
ext-lan-qos
ext-san-policy
Purpose
External SAN policy
Responsible Role
Storage Administrator
Controlled Objects
fabric:FcSan, fabric:FcSanEp, fabric:FcSanPc, fabric:FcSanPcEp, fabric:FcVsanPortEp, fabric:SanPinGroup,
fabric:SanPinTarget, fabric:Vsan, fcpool:Format, vnic:FcOEIf
ext-san-qos
Purpose
External SAN QoS
Responsible Role
Storage Administrator
Controlled Objects
qosclass:Definition, qosclass:EthBE, qosclass:EthClassified, qosclass:Fc
ext-san-security
Purpose
External SAN security
Responsible Role
Storage Administrator
Controlled Objects
There are no objects assigned to this privilege.
fault
Purpose
Alarms and alarm policies
Cisco UCS Manager XML API Programmers Guide
22 OL-20038-03
XML Object-Access Privileges
ext-san-policy
Responsible Role
Operations
Controlled Objects
callhome:Policy, event:EpCtrl, event:Log, fault:Holder, fault:Inst, fault:Policy
ls-config
Purpose
Service profile configuration
Responsible Role
Server Profile Administrator
Controlled Objects
bios:VFeat, bios:VfConsoleRedirection, bios:VfEnhancedIntelSpeedStepTech, bios:VfFrontPanelLockout,
bios:VfIntelHyperThreadingTech, bios:VfIntelTurboBoostTech, bios:VfIntelVTForDirectedIO,
bios:VfIntelVirtualizationTechnology, bios:VfLvDIMMSupport, bios:VfMirroringMode,
bios:VfNUMAOptimized, bios:VfProcessorC3Report, bios:VfProcessorC6Report, bios:VfQuietBoot,
bios:VfResumeOnACPowerLoss, bios:VfSelectMemoryRASConfiguration, bios:VProfile, extvmm:Ep,
extvmm:KeyRing, extvmm:KeyStore, extvmm:MasterExtKey, extvmm:Provider, extvmm:SwitchDelTask,
ls:ComputeBinding, ls:Binding, ls:Requirement, ls:Power, ls:Server, ls:Tie, lsboot:Def, lsboot:Lan,
lsboot:LanImagePath, lsboot:LocalStorage, lsboot:SanImage, lsboot:SanImagePath, lsboot:Storage,
lsboot:VirtualMedia, org:Org, power:Group, power:Regulation, power:Rule, sol:Config,
storage:LocalDiskConfigDef, storage:LocalDiskPartition, vm:Cont, vm:DirCont, vm:DC, vm:DCOrg, vm:Org,
vm:Switch, vm:DC, vm:DCOrg, vm:Org, vm:Switch, vm:VnicProfCl, vnic:BootTarget, vnic:DynamicCon,
vnic:Ether, vnic:EtherIf, vnic:Fc, vnic:FcIf, vnic:FcOEIf, vnic:IPv4Dhcp, vnic:IPv4Dns, vnic:IPv4If,
vnic:IPv4StaticRoute, vnic:IpV4PooledAddr, vnic:IpV4StaticAddr, vnic:Ipc, vnic:IpcIf, vnic:Scsi, vnic:ScsiIf
ls-config-policy
Purpose
Service profile configuration policy
Responsible Role
Server Profile Administrator
Controlled Objects
adaptor:EthCompQueueProfile, adaptor:EthFailoverProfile, adaptor:EthInterruptProfile,
adaptor:EthOffloadProfile, adaptor:EthRecvQueueProfile, adaptor:EthWorkQueueProfile,
adaptor:ExtIpV6RssHashProfile, adaptor:FcCdbWorkQueueProfile, adaptor:FcErrorRecoveryProfile,
adaptor:FcInterruptProfile, adaptor:FcPortFLogiProfile, adaptor:FcPortPLogiProfile, adaptor:FcPortProfile,
adaptor:FcRecvQueueProfile, adaptor:FcWorkQueueProfile, adaptor:HostEthIfProfile, adaptor:HostFcIfProfile,
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 23
XML Object-Access Privileges
ls-config
adaptor:IpV4RssHashProfile, adaptor:IpV6RssHashProfile, adaptor:RssProfile, extvmm:Ep, extvmm:KeyRing,
extvmm:KeyStore, extvmm:MasterExtKey, extvmm:Provider, extvmm:SwitchDelTask,
firmware:ComputeHostPack, firmware:ComputeMgmtPack, ls:AgentPolicy, ls:ComputeBinding, ls:Binding,
ls:Requirement, ls:Tier, lsboot:Def, lsboot:Lan, lsboot:LanImagePath, lsboot:LocalStorage, lsboot:Policy,
lsboot:SanImage, lsboot:SanImagePath, lsboot:Storage, lsboot:VirtualMedia, org:Org, sol:Config, sol:Policy,
storage:LocalDiskConfigDef, storage:LocalDiskConfigPolicy, storage:LocalDiskPartition, vm:Cont,
vm:DirCont, vm:DC, vm:DCOrg, vm:Org, vm:Switch, vm:DC, vm:DCOrg, vm:Org, vm:Switch, vm:VnicProfCl
ls-ext-access
Purpose
Service profile end point access
Responsible Role
Server Profile Administrator
This privilege is not used.
ls-network
Purpose
Service profile network
Responsible Role
Network Administrator
Controlled Objects
dpsec:Mac, extvmm:Provider, extvmm:SwitchDelTask, fabric:DceSwSrvEp, fabric:VCon, fabric:VConProfile,
flowctrl:Definition, flowctrl:Item, macpool:Format, nwctrl:Definition, qos:Definition, epqos:Definition,
epqos:DefinitionDelTask, qosclass:Definition, qos:Item, epqos:Item, epqos:Egress, qosclass:Item, qosclass:Eth,
qosclass:EthBE, qosclass:EthClassified, qosclass:Fc, vm:Cont, vm:DirCont, vm:DC, vm:DCOrg, vm:Org,
vm:Switch, vm:DC, vm:DCOrg, vm:Org, vm:Switch, vm:VnicProfCl, vnic:DefBeh, vnic:DynamicCon,
vnic:DynamicConPolicy, vnic:DynamicIdUniverse, vnic:Ether, vnic:EtherIf, vnic:IPv4Dhcp, vnic:IPv4Dns,
vnic:IPv4If, vnic:IPv4StaticRoute, vnic:IpV4PooledAddr, vnic:IpV4StaticAddr, vnic:Ipc, vnic:IpcIf,
vnic:LanConnTempl, vnic:Profile, vnic:ProfileSet
ls-network-policy
Purpose
Service profile network policy
Cisco UCS Manager XML API Programmers Guide
24 OL-20038-03
XML Object-Access Privileges
ls-ext-access
Responsible Role
Network Administrator
Controlled Objects
dpsec:Mac, fabric:DceSrv, fabric:DceSwSrv, fabric:DceSwSrvEp, fabric:EthDiag, fabric:FcDiag, fabric:VCon,
fabric:VConProfile, flowctrl:Definition, flowctrl:Item, ippool:Block, ippool:Pool, macpool:Block,
macpool:Format, macpool:Pool, nwctrl:Definition, qos:Definition, epqos:Definition, epqos:DefinitionDelTask,
qosclass:Definition, qos:Item, epqos:Item, epqos:Egress, qosclass:Item, qosclass:Eth, qosclass:EthBE,
qosclass:EthClassified, qosclass:Fc, uuidpool:Block, vnic:DynamicCon, vnic:DynamicConPolicy,
vnic:DynamicIdUniverse, vnic:LanConnTempl, vnic:Profile, vnic:ProfileSet
ls-power
Purpose
Service profile power management
Responsible Role
Facility Manager
ls-qos
Purpose
Service profile
Responsible Role
QoS Network Administrator
This privilege is not used.
ls-qos-policy
Purpose
Service profile QoS policy
Responsible Role
Network Administrator
Controlled Objects
flowctrl:Definition, flowctrl:Item, qos:Definition, epqos:Definition, epqos:DefinitionDelTask,
qosclass:Definition, qos:Item, epqos:Item, epqos:Egress, qosclass:Item, qosclass:Eth, qosclass:EthBE,
qosclass:EthClassified, qosclass:Fc
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 25
XML Object-Access Privileges
ls-power
ls-security
Purpose
Service profile security
Responsible Role
Server Security Administrator
Controlled Objects
aaa:EpAuthProfile, aaa:EpUser
ls-security-policy
Purpose
Service profile security policy
Responsible Role
Server Security Administrator
Controlled Objects
aaa:EpAuthProfile, aaa:EpUser
ls-server
Purpose
Service profile server management
Responsible Role
Server Security Administrator
Controlled Objects
bios:VFeat, bios:VfConsoleRedirection, bios:VfEnhancedIntelSpeedStepTech, bios:VfFrontPanelLockout,
bios:VfIntelHyperThreadingTech, bios:VfIntelTurboBoostTech, bios:VfIntelVTForDirectedIO,
bios:VfIntelVirtualizationTechnology, bios:VfLvDIMMSupport, bios:VfMirroringMode,
bios:VfNUMAOptimized, bios:VfProcessorC3Report, bios:VfProcessorC6Report, bios:VfQuietBoot,
bios:VfResumeOnACPowerLoss, bios:VfSelectMemoryRASConfiguration, bios:VProfile, ls:ComputeBinding,
ls:Binding, ls:Requirement, ls:Power, ls:Server, ls:Tier, lsboot:Def, lsboot:Lan, lsboot:LanImagePath,
lsboot:LocalStorage, lsboot:SanImage, lsboot:SanImagePath, lsboot:Storage, lsboot:VirtualMedia, power:Group,
power:Regulation, power:Rule, sol:Config, storage:LocalDiskConfigDef, storage:LocalDiskPartition,
vnic:BootTarget, vnic:DefBeh, vnic:DynamicCon, vnic:Ether, vnic:EtherIf, vnic:Fc, vnic:FcIf, vnic:FcNode,
Cisco UCS Manager XML API Programmers Guide
26 OL-20038-03
XML Object-Access Privileges
ls-security
vnic:FcOEI, vnic:IPv4Dhcp, vnic:IPv4Dns, vnic:IPv4If, vnic:IPv4StaticRoute, vnic:IpV4PooledAddr,
vnic:IpV4StaticAddr, vnic:Ipc, vnic:IpcIf, vnic:Scsi, vnic:ScsiIf
ls-server-oper
Purpose
Service profile consumer role
This privilege controls these operations on the service profile:
Launch KVM
Boot Server
Shutdown Server
Reset
Responsible Role
Server Profile Administrator
ls-server-policy
Purpose
Service profile pool policy
Responsible Role
Server Security Administrator
Controlled Objects
adaptor:EthCompQueueProfile, adaptor:EthFailoverProfile, adaptor:EthInterruptProfile,
adaptor:EthOffloadProfile, adaptor:EthRecvQueueProfile, adaptor:EthWorkQueueProfile,
adaptor:ExtIpV6RssHashProfile, adaptor:FcCdbWorkQueueProfile, adaptor:FcErrorRecoveryProfile,
adaptor:FcInterruptProfile, adaptor:FcPortFLogiProfile, adaptor:FcPortPLogiProfile, adaptor:FcPortProfile,
adaptor:FcRecvQueueProfile, adaptor:FcWorkQueueProfile, adaptor:HostEthIfProfile, adaptor:HostFcIfProfile,
adaptor:IpV4RssHashProfile, adaptor:IpV6RssHashProfile, adaptor:RssProfile, bios:VFeat,
bios:VfConsoleRedirection, bios:VfEnhancedIntelSpeedStepTech, bios:VfFrontPanelLockout,
bios:VfIntelHyperThreadingTech, bios:VfIntelTurboBoostTech, ios:VfIntelVTForDirectedIO,
bios:VfIntelVirtualizationTechnology, bios:VfLvDIMMSupport, bios:VfMirroringMode,
bios:VfNUMAOptimized, bios:VfProcessorC3Report, bios:VfProcessorC6Report, bios:VfQuietBoot,
bios:VfResumeOnACPowerLoss, bios:VfSelectMemoryRASConfiguration, bios:VProfile, fabric:VCon,
fabric:VConProfile, firmware:ComputeHostPack, firmware:ComputeMgmtPack, ls:AgentPolicy,
ls:ComputeBinding, ls:Binding, ls:Requirement, ls:Power, ls:Tier, lsboot:Policy, power:Group,
power:Regulation, power:Rule
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 27
XML Object-Access Privileges
ls-server-oper
ls-storage
Purpose
Service profile storage
Responsible Role
Storage Administrator
Controlled Objects
fcpool:Format, lsboot:Def, lsboot:Lan, lsboot:LanImagePath, lsboot:LocalStorage, lsboot:SanImage,
lsboot:SanImagePath, lsboot:Storage, lsboot:VirtualMedia, storage:LocalDiskConfigDef,
storage:LocalDiskConfigPolicy, storage:LocalDiskPartition, uuidpool:Format, vnic:BootTarget, vnic:DefBeh,
vnic:Fc, vnic:FcIf, vnic:FcNode, vnic:FcOEIf, vnic:SanConnTempl, vnic:Scsi, vnic:ScsiIf
ls-storage-policy
Purpose
Service profile storage policy
Responsible Role
Storage Administrator
Controlled Objects
fabric:VCon, fabric:VConProfile, fcpool:Block, fcpool:BootTarget, fcpool:Format, fcpool:Initiator,
fcpool:Initiators, lsboot:Def, lsboot:Lan, lsboot:LanImagePath, lsboot:LocalStorage, lsboot:SanImage,
lsboot:SanImagePath, lsboot:Storage, lsboot:VirtualMedia,
storage:LocalDiskConfigDefstorage:LocalDiskConfigPolicy, storage:LocalDiskPartition, uuidpool:Format,
vnic:SanConnTempl
operations
Purpose
Logs and Smart Call Home
Responsible Role
Operations
Controlled Objects
aaa:Log, callhome:Dest, callhome:Ep, callhome:PeriodicSystemInventory, callhome:Profile, callhome:Smtp,
callhome:Source, callhome:TestAlert, comm:DateTime, comm:NtpProvider, comm:Syslog, comm:SyslogClient,
Cisco UCS Manager XML API Programmers Guide
28 OL-20038-03
XML Object-Access Privileges
ls-storage
comm:SyslogConsole, comm:SyslogFile, comm:SyslogMonitor, condition:Log, aaa:Log, event:Log,
event:EpCtrl, event:Log, fault:Inst, stats:CollectionPolicy, stats:Curr, adaptor:EthPortBySizeLargeStats,
adaptor:EthPortBySizeSmallStats, adaptor:EthPortErrStats, adaptor:EthPortMcastStats,
adaptor:EthPortOutsizedStats, adaptor:EthPortStats, adaptor:EtherIfStats, adaptor:FcIfEventStats,
adaptor:FcIfFC4Stats, adaptor:FcIfFrameStats, adaptor:FcPortStats, adaptor:MenloBaseErrorStats,
adaptor:MenloDcePortStats, adaptor:MenloEthErrorStats, adaptor:MenloEthStats, adaptor:MenloFcErrorStats,
adaptor:MenloFcStats, adaptor:MenloHostPortStats, adaptor:MenloMcpuErrorStats, adaptor:MenloMcpuStats,
adaptor:MenloNetEgStats, adaptor:MenloNetInStats, adaptor:MenloQErrorStats, adaptor:MenloQStats,
adaptor:VnicStats, compute:IOHubEnvStats, compute:MbPowerStats, compute:MbTempStats,
compute:PCIeFatalCompletionStats, compute:PCIeFatalProtocolStats, compute:PCIeFatalReceiveStats,
compute:PCIeFatalStats, equipment:ChassisStats, equipment:FanModuleStats, equipment:FanStats,
equipment:IOCardStats, equipment:PsuInputStats, equipment:PsuStats, ether:ErrStats, ether:LossStats,
ether:PauseStats, ether:RxStats, ether:TxStats, fc:ErrStats, fc:Stats, memory:ArrayEnvStats,
memory:BufferUnitEnvStats, memory:ErrorStats, memory:Runtime, memory:UnitEnvStats, processor:EnvStats,
processor:ErrorStats, processor:Runtime, sw:EnvStats, sw:SystemStats, stats:Holder, stats:Thr32Definition,
stats:Thr32Value, stats:Thr64Definition, stats:Thr64Value, stats:ThrFloatDefinition, stats:ThrFloatValue,
stats:ThresholdClass, stats:ThresholdDefinition, stats:Thr32Definition, stats:Thr64Definition,
stats:ThrFloatDefinition, stats:ThresholdPolicy, stats:ThresholdValue, stats:Thr32Value, stats:Thr64Value,
stats:ThrFloatValue, sysdebug:AutoCoreFileExportTarget, sysdebug:BackupBehavior, sysdebug:Core,
sysdebug:CoreFileExportTarget, sysdebug:AutoCoreFileExportTarget, ysdebug:ManualCoreFileExportTarget),
sysdebug:CoreFileRepository, sysdebug:LogControlDestinationFile, ysdebug:LogControlDestinationSyslog,
sysdebug:LogControlDomain, sysdebug:LogControlEp, sysdebug:LogControlModule, sysdebug:MEpLog,
sysdebug:MEpLogPolicy, sysdebug:ManualCoreFileExportTarget, sysfile:Mutation
pn-equipment
Purpose
Server hardware management
Responsible Role
Server Equipment Administrator
Controlled Objects
adaptor:ExtIf, adaptor:ExtEthIf, adaptor:HostIf, adaptor:HostEthIf, adaptor:HostFcIf, compute:Blade,
compute:PsuPolicy, diag:SrvCtrl, equipment:Chassis, equipment:Led, equipment:IndicatorLed,
equipment:LocatorLed, fabric:ComputeSlotEp, fabric:SwChPhEp
pn-maintenance
Purpose
Server maintenance
Responsible Role
Server Equipment Administrator
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 29
XML Object-Access Privileges
pn-equipment
Controlled Objects
adaptor:ExtIf, adaptor:ExtEthIf, adaptor:HostIf, adaptor:HostEthIf, adaptor:HostFcIf, compute:Blade,
diag:SrvCtrl, equipment:Chassis, equipment:Led, equipment:IndicatorLed, equipment:LocatorLed,
fabric:ComputeSlotEp, fabric:SwChPhEp
pn-policy
Purpose
Server policy
Responsible Role
Server Equipment Administrator
Controlled Objects
adaptor:CapQual, adaptor:Qual, bios:VFeat, bios:VfConsoleRedirection, bios:VfEnhancedIntelSpeedStepTech,
bios:VfFrontPanelLockout, bios:VfIntelHyperThreadingTech, bios:VfIntelTurboBoostTech,
bios:VfIntelVTForDirectedIO, bios:VfIntelVirtualizationTechnology, bios:VfLvDIMMSupport,
bios:VfMirroringMode, bios:VfNUMAOptimized, bios:VfProcessorC3Report, bios:VfProcessorC6Report,
bios:VfQuietBoot, bios:VfResumeOnACPowerLoss, bios:VfSelectMemoryRASConfiguration, bios:VProfile,
compute:AutoconfigPolicy, compute:Blade, compute:BladeDiscPolicy, compute:BladeInheritPolicy,
compute:ChassisDiscPolicy, compute:ChassisQual, compute:DiscPolicy, compute:BladeDiscPolicy,
compute:ChassisDiscPolicy, compute:PhysicalQual, compute:Pool, compute:PooledPhysical,
compute:PooledSlot, compute:PooledSlot, compute:PoolingPolicy, compute:PsuPolicy, compute:Qual,
compute:QualItem, adaptor:CapDef, adaptor:CapQual, adaptor:CapSpec, adaptor:Qual, compute:BladePosQual,
compute:ChassisQual, compute:SlotQual, compute:PhysicalQual, memory:Qual, processor:Qual, storage:Qual,
compute:ScrubPolicy, compute:SlotQual, diag:BladeTest, diag:NetworkTest, diag:RunPolicy,
equipment:Chassis, equipment:Led, equipment:IndicatorLed, equipment:LocatorLed, extvmm:Ep,
extvmm:KeyRing, extvmm:KeyStore, extvmm:MasterExtKey, extvmm:Provider, extvmm:SwitchDelTask,
fabric:ComputeSlotEp, fabric:SwChPhEp, memory:Qual, org:Org, processor:Qual, storage:Qual, uuidpool:Pool,
vm:Cont, vm:DirCont, vm:DC, vm:DCOrg, vm:Org, vm:Switch, vm:DC, vm:DCOrg, vm:LifeCyclePolicy,
vm:Org, vm:Switch, vm:VnicProfCl
pn-security
Purpose
Server security
Responsible Role
Server Security Administrator
Controlled Objects
mgmt:IntAuthPolicy
Cisco UCS Manager XML API Programmers Guide
30 OL-20038-03
XML Object-Access Privileges
pn-policy
pod-config
Purpose
Pod configuration
Responsible Role
Network Administrator
This privilege is not used.
pod-policy
Purpose
Pod policy
Responsible Role
Network Administrator
This privilege is not used.
pod-qos
Purpose
Pod QoS
Responsible Role
Network Administrator
This privilege is not used.
pod-security
Purpose
Pod security
Responsible Role
Network Administrator
This privilege is not used.
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 31
XML Object-Access Privileges
pod-config
power-mgmt
Purpose
Data center power management
This role provides read and write access for power capacity management including power group configurations
and other power-related policies.
Responsible Role
Facility Manager
read-only
Purpose
Read-only access
Responsible Role
This is not a selectable privilege. All roles have read-only access to all objects. Roles that have read-write
privileges on some objects also have read-only access to all other objects.
Cisco UCS Manager XML API Programmers Guide
32 OL-20038-03
XML Object-Access Privileges
power-mgmt
I NDE X
A
API 1, 4
empty results example 4
failed request example 4
flow 1
response to success or failure example 4
successful request example 4
authentication methods 2
description 2
C
configResolveChildren 9
example 9
configResolveDn 9
example 9
configResolveParent 10
example 10
configuration methods 3
cookie 2, 7
cURL utility 7
D
distinguished name 2, 9
description 2
resolving 9
E
empty results 4
event subscription 4
eventSubscribe method 4
examples 9, 10
resolving a distinguished name 9
resolving children 9
resolving parents 10
F
failed request 4
M
management information tree (MIT) 1
place in API flow 1
structure 1
Q
query methods 3, 9, 10
configResolveChildren 9
configResolveDn 9
configResolveParent 10
R
relative name 2
example 2
resolving children example 9
resolving parents 10
example 10
S
successful request 4
U
UCS API 1
model documentation 1
UCS Manager 1
information model 1
Cisco UCS Manager XML API Programmers Guide
OL-20038-03 IN-1
X
XML 1
XML (continued)
API flow 1
Cisco UCS Manager XML API Programmers Guide
IN-2 OL-20038-03
Index