ucp 4.0 director api reference · ©2014-2015hitachidatasystemscorporation.allrightsreserved....
TRANSCRIPT
Unified Compute Platform 4.0UCP Director API Reference
MK-92UCP046-07
© 2014 - 2015 Hitachi Data Systems Corporation. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or by any means, electronic ormechanical, including photocopying and recording, or stored in a database or retrieval system for anypurpose without the express written permission of Hitachi Data Systems Corporation (hereinafter referredto as “Hitachi Data Systems”).
Hitachi Data Systems reserves the right to make changes to this document at any time without notice andassumes no responsibility for its use. This document contains the most current information available at thetime of publication. When new or revised information becomes available, this entire document will beupdated and distributed to all registered users.
Some of the features described in this document might not be currently available. Refer to the most recentproduct announcement for information about feature and product availability, or contact Hitachi DataSystems at https://portal.hds.com.
Notice: Hitachi Data Systems products and services can be ordered only under the terms and conditions ofthe applicable Hitachi Data Systems agreements. The use of Hitachi Data Systems products is governed bythe terms of your agreements with Hitachi Data Systems.
By using this software, you agree that you are responsible for:
a) Acquiring the relevant consents as may be required under local privacy laws or otherwise fromemployees and other individuals to access relevant data; and
b) Ensuring that data continues to be held, retrieved, deleted, or otherwise processed in accordance withrelevant laws.
Hitachi is a registered trademark of Hitachi, Ltd., in the United States and other countries. Hitachi DataSystems is a registered trademark and service mark of Hitachi, Ltd., in the United States and othercountries.
Microsoft product screen shots reprinted with permission from Microsoft Corporation.
All other trademarks, service marks, and company names in this document or web site are properties oftheir respective owners.
Contents
Preface xviiIntended audience xviiProduct version xviiRelated documents xviiGetting help xviiiComments xviii
Chapter 1: Introducing the UCPDirector API 1Uniform resource identifiers 1HTTP methods 1Jobs 2Input and output format 3Representation of DateTime values 3Return codes 3Common properties 4Access and authentication 5
Chapter 2: UCPDirector resources 7Get information about UCP Director API 7
Example: Get API information 8Chassis resources 9
List all chassis 10Example: List all chassis 10
Get a chassis 10Example: Get a chassis 18
Update chassis firmware 49Example: Update chassis firmware 50
Update chassis and blade firmware 50
Contents iiiUCP Director API Reference
Example: Update chassis and server firmware 51Cluster resources 51
List clusters 52Example: List all clusters 52
Get cluster 54Example: Get a cluster 54
Change ESXi image used by a cluster 55Create cluster with service template 56Attach volume to cluster 58Detach volume from cluster 60Create and attach volume to cluster 61Get servers for a cluster 62Example: Get 3 servers for a cluster 63
Deploy cluster 63Get cluster networks 64Example: Get VLAN configuration from all servers in a cluster 65
Apply cluster network VLANs to Ethernet switches 66Converged switch resources 67
List converged switches 68Example: List all converged switches 68
Get converged switch 116Example: Get a converged switch 119
Add converged switch 143Remove converged switch 144Example: Remove a converged switch from inventory 145
Get converged switch connection information 145Example: Get connection information for a converged switch 146
Modify converged switch connection information 147Example: Modify the credentials used to manage a converged switch 148
Get unmanaged ports on a converged switch 148Example: Get a converged switch’s unmanaged ports 149
Set unmanaged ports on a converged switch 150Example: Specify unmanaged ports for an converged switch 151
Refresh converged switch inventory 151Example: Refresh converged switch inventory 152
Configuration resources 152Set UCP configuration 153Example: Update UCP configuration 154
Get UCP Configuration 154
iv Contents
UCP Director API Reference
Example: Get UCP configuration 155Element manager resources 156
List server element managers 157Example: List server element managers 157
Get server element manager 159Example: Get a server element manager 159
Modify server element manager connection information 161Example: Modify the credentials used to access a server elementmanager 161
List storage element managers 162Example: List storage element managers 162
Get storage element manager 164Example: Get a storage element manager 164
Modify storage element manager connection information 166Example: Modify the credentials used to access a storage elementmanager 166
Ethernet switch resources 167List Ethernet switches 169Example: List all Ethernet switches 170
Get Ethernet switch 269Example: Get an Ethernet switch 272
Add Ethernet switch 297Remove Ethernet switch 298Example: Remove an Ethernet switch from inventory 299
List Ethernet switch configurations 299Example: List all saved configurations for an Ethernet switch 300
Get Ethernet switch configuration 308Example: Get a saved configuration for an Ethernet switch 309
Create Ethernet switch configuration backup 324Modify a saved configuration backup for an Ethernet switch 325Example: Update details for an Ethernet switch configuration 325
Delete Ethernet switch configuration backup 326Example: Delete an Ethernet switch configuration 326
Restore Ethernet switch configuration backup 326Example: Restore an Ethernet switch configuration 327
Get retention policy for Ethernet switch configuration backups 327Example: Get Ethernet switch configuration retention policy 328
Set retention policy for Ethernet switch configuration backups 329Example: Set retention policy for Ethernet switch configuration 330
Contents vUCP Director API Reference
backupsGet Ethernet switch connection information 330Example: Get connection information for an Ethernet switch 331
Modify Ethernet switch connection information 332Example: Modify the credentials used to manage an Ethernet switch 333
Get unmanaged ports on an Ethernet switch 334Example: Get an Ethernet switch’s unmanaged ports 334
Set unmanaged ports on an Ethernet switch 336Example: Specify unmanaged ports on an Ethernet switch 336
Refresh Ethernet switch inventory 337Example: Refresh Ethernet switch inventory 338
Get status of UCP Ethernet features 338Example: Get Ethernet switches host network configurationenabled/disabled state 339
Modify status of UCP Ethernet features 340Example: Update Ethernet switches host network configuration toenabled 340
Update Ethernet switch firmware 341Example: Update firmware on a specified Ethernet switch 341Example: Update firmware on all Ethernet switches 342
Image resources 342List images 342Get an image by ID 342
ESXi image and repository resources 343Create ESXi image 343Modify ESXi image 345Example: Modify an image 346
Remove ESXi image 361Example: Remove an ESXi image 361
Scan and update active images 362Example: Update active images 362
List image packages 362Example: List packages 364
Get image repository locations 365Example: Get image repository locations 366
Modify image repository locations 366Example: Modify image repository locations 367
Get active image update notification recipients 367Example: Get active image update notification recipients 367
vi Contents
UCP Director API Reference
Modify active image update notification recipients 369Example: Modify active image update notification recipients 369
Refresh image inventory 370Example: Refresh image inventory 370
Event resources 371List UCP events 371Example: List most recent 100 UCP events 372Example: Get UCP events associated with a job 372Example: Get page 1 of UCP events for an Ethernet switch 373Example: Get 3 events related to a specified server 379Example: Get a page of 50 events, skipping first 100 382
Get UCP event 384Example: Get a UCP event by its Id 385
Purge UCP events 387Example: Purge UCP events 387
Fibre Channel fabric resources 387List Fibre Channel fabrics 388Example: List all fabrics 388
Get Fibre Channel fabric 389Example: Get a fabric 389
List zones in a Fibre Channel fabric 392Example: List all zones in a fabric 393Example: List all zones in a fabric that are used by a server 393
Get zone in a Fibre Channel fabric 397Example: Get a zone in a fabric 397
Create zone in a Fibre Channel fabric 399Modify zone in a Fibre Channel fabric 400Example: Modify the WWNs in a zone 401
Remove zone from a Fibre Channel fabric 401Example: Remove a zone from a fabric 402
Fibre Channel switch resources 402List Fibre Channel switches 403Example: List all Fibre Channel switches 403
Get Fibre Channel switch 404Example: Get a Fibre Channel switch 407
Add Fibre Channel switch 431Example: Add a Fibre Channel switch to inventory 432
Remove Fibre Channel switch 432Example: Remove a Fibre Channel switch from inventory 432
Contents viiUCP Director API Reference
Get Fibre Channel switch connection information 433Example: Get connection information for a Fibre Channel switch 433
Modify Fibre Channel switch connection information 434Example: Modify the credentials used to manage a Fibre Channel switch434
Refresh Fibre Channel switch inventory 435Example: Refresh Fibre Channel switch inventory 435
Update firmware on Fibre Channel switches 435Example: Update firmware on all Fibre Channel switches 436
Update firmware on one Fibre Channel switch 436Example: Update firmware on specified Fibre Channel switch 437
Job resources 438List UCP jobs 439Example: List UCP jobs 439
Get UCP job 439Example: Get details for a specific UCP job 441
List UCP jobs by filtered criteria 446Example: Get page 1 of UCP jobs 450Example: Get page 2 of UCP jobs 455Example: Get Running jobs 460Example: Get UCP jobs targeting a specific server 461
Purge UCP jobs 464Example: Purge UCP jobs 464
Monitoring resources 465List all resource types 466Example: Get monitor information for all resource types 473
List resources within a resource type 502Example: Get monitor information for StorageSystem 503
Set monitor mode for a resource type or a resource 506Example: Update monitor mode Ethernet switches to Report 507Example: Update monitor mode for Ethernet switch port to Report 508
Get monitor mode for a resource type or a resource 508Example: Get monitor mode for top level resource Ethernet 509Example: Get monitor mode for EthernetSwitchPort 509
Configure SNMP settings 510Get SNMP settings 512Example: Get SNMP settings for Ethernet switches 513
Get SNMP trap receiver 513Example: Get IP and port to use for SNMP trap destination 514
Refresh monitor states 515
viii Contents
UCP Director API Reference
Example: Manually refresh monitor states 515Get monitor state for a resource type 516Example: Get monitor state for all Storage resources 516
Performance Monitoring resources 568List aggregation frequencies 569Example: List aggregation frequencies 569
Get performance counter threshold 570Example: Get Capacity of StoragePool 571
Set performance counter threshold 571Example: Set threshold levels on Ethernet Switch CPUUsageperformance counter 572Example: Set threshold levels on StoragePool UsedPercentageperformance counter 573
Get performance data for a resource type 574Example: Get Performance Counter Data for Unallocated Space in theStorage System 576
Get performance data with paging for a resource 578Example: Get Performance Data Counter for Unallocated Space in theStorage System with Offset 5 and Page Size 5 578
Get multiple performance counters for multiple resouces 580Example: Get multiple performance counters from multiple resources 580
Get historical performance of a resource 581Example: Get historical performance 582
Get performance data by aggregation frequency 583Example: Get performance data by aggregation frequency 583
Scheduled job resources 585List scheduled jobs 585Example: List scheduled jobs 586
Get scheduled job 586Example: Get a scheduled job 587
Modify scheduled job 588Example: Modify the schedule for the update active images scheduledjob 589
Server resources 589List servers 590Example: List all servers 591
Get server 591Example: Get a server 599
Change server name 604Get the boot policy of a server by its MAC 604
Contents ixUCP Director API Reference
Example: Get boot policy of a server in Custom boot type 605Example: Get boot policy of a server in Custom boot type 605
Deploy pending image to server 605Get host networks 606Example: Get a host's network uplink configurations 607
Apply host network VLANs to Ethernet switches 608Create and attach volume to host 609Attach volume to host 610Detach volume from host 611Update server firmware 612Example: Update server firmware 613
Set pending image for server 613Example: Set a pending image for a specific server 614
Turn off server LID 614Example: Turn off a server’s LID 614
Turn on server LID 615Example: Turn on a server’s LID 615
Power off server 615Example: Power off a server 616
Reset server 616Example: Reset a server 617
Power on server 617Example: Power on a server 617
Get server hierarchy 618Example: Get hierarchy for all servers in vCenter 618
List server images 621Example: List all images 625Example: Get details for image 7 652
Get server image by Id 656Example: Get details for image 5 656
Refresh server inventory 658Example: Refresh servers in inventory 658
Server Identity resources 658List identities 660Example: List all identities 660
Get identity by ID 661Example: Get Identity 661
Get identity by ID 663Example: Get Identity by ID 663
x Contents
UCP Director API Reference
List identity types 665Example: List identity types 665
Get filtered list of reserved identities by pool type 667Example: List all reserved IP Addresses 667Example: List all reserved MAC Addresses 669Example: List all reserved WWN identities 670Example: List all UUID identities 672
Get filtered list of reserved identities by pool ID 673Example: Get all reserved identities from specified IP Address Pool 674Example: Get all reserved identities from specified MAC Address Pool 675Example: Get all reserved identities from specified WWN Address Pool 677Example: Get all reserved identities from specified UUID Pool 678
List IP address identity pools 679Example: List all IP address identity pools 679
Get IP address identity pool by ID 680Example: Get IP address pool by ID 681
Add IP address pool range 682Delete IP address range 683List IP address ranges 684Example: List allranges in IP address pool 1 684
Get IP address range by ID 686Example: Get IP address range 3 687
List all MAC address identity pools 689Example: List all MAC address identity pools 689
Get MAC address identity pool by ID 691Example: Get MAC address pool by ID 691
List MAC address ranges 693Example: List MAC address ranges in MAC address pool 2 693
Get MAC address range by ID 695List WWN identity pools 697Example: List all WWN identity pools 697
Get WWN identity pool by ID 699Example: Get WWN identity pool 699
Get WWN identity pool by ID 701Example: Get WWN identity pool 701
List WWN ranges 703Example: List WWN ranges in WWN pool 4 703
Get WWN range by ID 705Example: Get Wwn Address Range 2 706
Contents xiUCP Director API Reference
List UUID identity pools 708Example: List UUID identity pools 708
Get UUID identity pool by ID 710Example: Get UUID identity pool by ID 710
Server profile resources 712List all server profiles 715Example: List all server profiles 715
Get server profile 716Example: Get a server profile 719
Create a server profile 722Edit a server profile 733Delete a server profile 734Apply a server profile 735Get DDR voltage level option by ID 736Example: Get DDR voltage level option by ID 736
List DDR voltage level options for EFI settings 736Example: List DDR voltage level options 736
Get memory mode option by ID 743Example: Get memory mode option by ID 743
List memory mode options for EFI settings 744Example: List memory mode options 744
Get node interleave option by ID 749Example: Get node interleave option by ID 749
List node interleave options for EFI settings 750Example: List node interleave modes 750
Get memory speed option by ID 754List memory speed options for EFI settings 755List processor hardware prefetcher options for EFI settings 767List processor hyper-threading options for EFI settings 771Example: List processor hyper-threading modes 772
List processor turbo mode options for EFI settings 776List RAS deconfigured mode options for EFI settings 780Example: List RAS deconfigured modes 780
Server type resources 784List server types 784Example: List all server types 784
Get server type 784Example: Get a server type 785
Set default image for a server type 786
xii Contents
UCP Director API Reference
Example: Set a default image for a server type 787Service Template Resources 788
List all service templates 790Example: List service templates 791
Create Linux service template 791List Linux service templates 793Example: List Linux service templates 793
Get Linux service template by ID 793Example: Get Linux service template by ID 794
Edit Linux service template 795Apply Linux service template 797Create Windows service template 799List Windows service templates 801Example: List Windows service templates 801
Get Windows service template 802Edit Windows service template 804Apply Windows service template 806Create ESXi host service template 807List ESXi host service templates 809Example: List ESXi host service templates 810
Get ESXi host service template 810Example: Get ESXi host service template by ID 810
Edit ESXi host service template 812Apply ESXi host service template 814Create ESXi cluster service template 816List ESXi cluster service templates 820Example: List ESXi cluster service templates 820
Get ESXi cluster service template 820Example: Get ESXi cluster service template by ID 821
Edit ESXi cluster service template 822Apply cluster service template 826Create custom service template 826List custom service templates 827Example: List custom service templates 827
Get custom service template 827Example: Get custom service template by ID 828
Edit custom service template 829Apply custom service template 830Create Windows Hyper-V service template 832
Contents xiiiUCP Director API Reference
List Windows Hyper-V service templates 834Example: List Windows Hyper-V service templates 834
Get Windows Hyper-V service template 834Example: Get Windows Hyper-V service template by ID 835
Edit Windows Hyper-V service template 836Apply Windows Hyper-V service template 839Delete service template 841Copy service template 841List volumes associated with a service template 842Example: List volumes from specific serice template 842
Get details for a volume associated with a service template 846Example: Get a volume from a specified service template – datastore tocreate 850Example: Get a volume from specified service template – attach existingvolume 852
Storage system resources 854List storage systems 855Example: List storage systems 855
Get storage system 856Example: Get a storage system 858
List parity groups 864Example: List all parity groups on the storage system 865
Get parity group by ID 867Example: Get a parity group 867
List physical devices 870Example: List the physical devices on a HUS150 870
List storage system pools 873Example: List a storage system’s pools 873
Get storage system pool 875Example: Get a pool from a storage system 877
List storage system ports 880Example: List a storage system’s ports 880
Get storage system port 884Example: Get a port on a storage system 885
List storage system processors 887Example: List the storage system processors 888
List storage system volumes 891Example: List all volumes in a storage system 892Example: List all volumes in a storage system pool 894
xiv Contents
UCP Director API Reference
Example: List all volumes in a storage system that are attached to aserver 897Example: List all volumes in a storage system that are attached to acluster 899
Get storage system volume 901Example: Get a volume 902
Create storage system volume 905Delete storage system volume 906Expand storage system volume 906Example: Expand a volume that is attached to a server 907
Refresh storage system inventory 907Example: Refresh storage system inventory 908
Get syslog 908Example: Get actions attempted by unauthorized users 909
Upload firmware bundle into UCP 910Example: Copy update package from network location 911
Virtual platform manager resources 911List virtual platform managers 912Example: List virtual platform managers 912
Get virtual platform manager 914Example: Get a virtual platform manager (vCenter) 914
Update virtual platform manager 918Example: Update SCVMM virtual platform manager 919Example: Update vCenter virtual platform manager 919
Modify virtual platform manager connection information 920Example: Change details of the platform connection information 921
List vSphere host profiles 922Example: List host profiles in vCenter 923
Get details for a vSphere host profile 926Example: Get host profile by name 926
List vSphere virtual distributed switches 928Example: List virtual distributed switches in the virtual platform 929
Get vSphere virtual distributed switch 932Example: Get a virtual distributed switch by Id 932
List virtual machines 934Example: List virtual machines in the platform 934
Get details for a virtual machine 960Example: Get a virtual machine in the virtual platform manager 961
Get user privileges 962
Contents xvUCP Director API Reference
Example: Get user privileges 963
xvi Contents
UCP Director API Reference
Preface
This guide explains how to use the Hitachi Unified Compute Platform(UCP) Director API.
Intended audienceThis guide is intended for system administrators who use the API toadminister UCP Director.
Product versionThis book applies to release 4.0 of UCP.
Related documentsThe following documents contain additional information about UCP 4.0:
• UCP Pre-Installation Requirements and Configuration— Containsinformation and procedures you need to be aware of for a successful UCPinstallation.
• UCP Administration Manual— Contains technical and usageinformation for UCP and UCP Director. Describes how to administer UCPDirector through UCP Director Console with both VMware vCenter andMicrosoft SCVMM.
• UCP Director API Reference — Describes how to use the UCP DirectorAPI.
• UCP Director CLI Reference — Describes how to use the UCP DirectorCLI.
Preface xviiUCP Director API Reference
• UCP Director Third-Party Copyrights and Licenses — Containscopyright and license information for the third-party softwaredistributed with or embedded in UCP Director.
• UCP DOC Administration Manual— Contains technical and usageinformation for Unified Compute Platform Director Operations Center(UCP DOC). Describes how to administer UCP DOC through UCP DOCConsole.
• UCP DOC API Reference — Describes how to use the UCP DOC API.
• UCP DOC CLI Reference — Describes how to use the UCP DOC CLI.
Getting helpHitachi Data Systems Support Portal is the destination for technicalsupport for your current or previously sold storage systems, midrange andenterprise servers, and combined solution offerings. The Hitachi DataSystems® customer support staff is available 24 hours a day, seven days aweek. If you need technical support, log into the Hitachi Data SystemsSupport Portal for contact information: http://portal.hds.com
Hitachi Data Systems Community is a global online community forHDS customers, partners, independent software vendors, employees, andprospects. It is an open discussion among these groups about theHDS portfolio of products and services. It is the destination to get answers,discover insights, and make connections. The HDS Communitycomplements our Support Portal and support services by providing an areawhere you can get answers to noncritical issues and questions. Join theconversation today! Go to http://community.hds.com, register, andcomplete your profile.
CommentsPlease send us your comments on this document:
Include the document title and number, including the revision (forexample, -01), and refer to specific sections and paragraphs wheneverpossible. All comments become the property of Hitachi Data Systems.
Thank you!
Getting help
xviii Preface
UCP Director API Reference
Introducing the UCP Director API
The UCP Director API is a RESTful API. Concepts are organized intoresources and each resource is identified by a URI. Clients may request thecurrent state of a resource and request changes to that state using standardHTTP methods.
Uniform resource identifiersEvery instance of a resource is uniquely identified by a URI. For example,here is the URI for storage system 53106:
https://ucpmanagement.ucp.local/api/storagesystems/53106
Resources may contain sub-resources. For example, storage systems havevolumes. Here is a URI for volume 3653 on storage system 53106:
https://ucpmanagement.ucp.local/api/storagesystems/53106/volumes/3653
Lists of resources may be requested of many parent URIs. For example,doing a GET on the following URI will produce a list of the volumes onstorage system 53106:
https://ucpmanagement.ucp.local/api/storagesystems/53106/volumes
HTTP methodsThe UCP Director API supports the following HTTP methods:
• GET – Retrieves the current state of a resource.
• POST – Creates a new resource or performs an action on an existingresource.
• PUT – Updates a resource.
Chapter 1: Introducing the UCP Director API 1UCP Director API Reference
1
• DELETE – Removes a resource.
JobsMany HTTP requests will execute a changes to resources, will refreshinventory, or will add a resource. In such cases, a job will start and theprogress is reported via the platform manager. The only exception is"Modify server element manager connection information" on page 161.
As a job progresses, informational events are reported. Errors and warningsare also reported as events. "Job resources" on page 438may be used toget information about jobs. "Event resources" on page 371may be usedto find information on specific events across multiple jobs.
Common properties of jobs are listed here rather than repeated throughoutthis document. For examples of actual jobs, see the section "Job resources"on page 438.
• Id – Job ID
• ResourceType – Always “Job”
• GlobalResourceId – Globally unique resource ID of the job
• InstanceId – Instance Id for the instance of UCP Director
• Links – Collection of hypermedia links related to the job
¡ “self” – A link to the job itself
¡ “collection” – A link to display all jobs
¡ “events” – A link to the events within the job
¡ “target” – A link to the resource targeted by the job
• CreatedBy – Displays the user who initated the job
• EndTime – End time of the job
• Events – Collection of events related to the job
• JobId – Job ID
• JobType – Job Type
2 Chapter 1: Introducing the UCP Director API
UCP Director API Reference
Jobs
• Name – Name of the job
• Progress – Current progress of the job
• StartTime – Collection of the following to timing events
¡ DateTime – Date and time the job was started
¡ OffsetMinutes – Offset from UTC time
• Status – Current status of the job: Running, Complete or Failed
• TargetId – Target of the resource against which the job was executed
• TargetType – Type of resource against which the job was executed
Input and output formatThe body of all requests and responses are represented in JSON format.
Representation of DateTime valuesDateTime query parameter values are passed in as strings. They can be inany format accepted by the DateTimeOffset.Parse method in the Microsoft.NET Framework version 4.5. The input string is assumed to be in a formatmatching the operating system locale setting on the UCP management VM.If no time zone offset is specified, the time zone is assumed to be UTC.
DateTime values in API response bodies are represented by JSONconvention as strings with the format /Date(1347529770000-0700)/. Thenumber before the ‘-’ character is the number of milliseconds sincemidnight, January 1, 1970. The number after the ‘-’ character is anhour/minute offset representing the time zone offset relative to UTC.
Return codesWhen a request succeeds, one of the following HTTP status codes arereturned from the request:
• 200 OK – A GET method has succeeded and the body of the responsecontains the requested information.
Chapter 1: Introducing the UCP Director API 3UCP Director API Reference
Input and output format
• 202 Accepted – A PUT, POST, or DELETE method has successfullystarted a job and the body of the response contains the job.
When a request fails, one of the following HTTP status codes are returned inthe response:
• 400 Bad Request – The request body is not valid.
• 401 Unauthorized – The client does not have the required privilege.
• 404 Not Found – The URI is invalid or the resource could not be found.
• 405 Method Not Allowed – The URI is valid but the verb is not allowed.
• 500 Internal Error – The request was accepted but failed duringexecution.
• 501 Not Implemented – The request may be validly constructed but it isnot implemented.
When a request fails, the body of the responses will contain a description ofthe problem.
Common propertiesWhere an API returns a resource or a list of resources, they contain commonproperties which are listed here rather than repeated throughout thisdocument.
Name Type Notes
Id StringId of the resource. Commonly used in Getrequests
ResourceType String Type of resource
GlobalResourceId StringGlobally unique Id of the resource.Commonly used in filtering criteria
InstanceId StringId number of the Datacenter Directorinstance
Links CollectionA collection of hypermedia links related tothe resource. The list of links may differfrom resource to resource
4 Chapter 1: Introducing the UCP Director API
UCP Director API Reference
Common properties
Access and authenticationIn SCVMM, UCP Director leverages the Administrator role. All API requirethis role.
In vCenter, UCP Director leverages vCenter roles and privileges to managesecurity. During platform registration, the following privileges are added tovCenter:
• UCP View
• UCP System Administration
• UCP Server Administration
• UCP Storage Administration
• UCP Network Administration
• UCP Server Console Access
• UCP Storage Console Access
• UCP Network Console Access
• UCP Reset VLAN Access
Each resource requires one of these privileges and a caller must be grantedthe appropriate UCP privilege in vCenter. The privilege required for eachuse of a resource is identified in the resource details.
All connections to UCP Director’s API are secured with TLS. Windowsauthentication is used to authenticate the caller for the session. Requestson a new connection will see “WWW-Authenticate: Negotiate” in theresponse header to initiate the negotiation process.
Chapter 1: Introducing the UCP Director API 5UCP Director API Reference
Access and authentication
6 Chapter 1: Introducing the UCP Director API
UCP Director API Reference
UCP Director resources
The UCP Director API is organized into resources that are grouped withrelated resources. Requests for each resource are named based on theirintended use and described in terms of their URI, HTTP method, andrequired privilege. The details for each request include a definition of therequest and response bodies as well an example of its use.
Get information about UCP Director APIThis HTTP request uses the GET method on the /api/about URI.
In vCenter, the UCP View privilege is required.
Method URIvCenterPrivilege
GET /api/about UCP View
Request body
The body for this request must be empty.
Response body
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
Name Type Notes
SerialNumber StringThe serial number entered duringinstallation.
Version String The current version of UCP Director.
Chapter 2: UCP Director resources 7UCP Director API Reference
2
Name Type Notes
ApplianceInformation CollectionCollection of information about UCPmodeland configuration (or platform).
Model String Model of UCP
IsConvergedNetwork BooleanWhether or not the model of networkinguses converged adapter and convergedswitches.
SystemNumber Int32The number of UCP, for example the first,second or third UCP in an environment.
IsEthernetFabricEnabled BooleanWhether the Ethernet switches useBrocade VCS technology.
OptionalComponents Collection Collection of UCP optional components.
Name String Name of the optional component.
Installed BooleanWhether the optional component isinstalled in this instance of UCP.
Example: Get API information
Request HeaderGET https://ucpmanagement.ucp.local/api/about HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "UCP-12345","ResourceType": "Instance","GlobalResourceId": "inst.UCP-12345","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.podj.local\/api\/instance"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Instance&targetId=inst.UCP-12345&relation=self"},{"Rel": "jobs.subcomponent",
8 Chapter 2: UCP Director resources
UCP Director API Reference
Get information about UCP Director API
"Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Instance&targetId=inst.UCP-12345&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Instance&targetId=inst.UCP-12345&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Instance&targetId=inst.UCP-12345&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Instance&targetId=inst.UCP-12345&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Instance&targetId=inst.UCP-12345&relation=self%7Csubcomponent"}],"SerialNumber": "UCP-12345","Version": "3.5.0.4626","ApplianceInformation": {"Model": "4000CVm Rev.1","IsConvergedNetwork": false,"SystemNumber": 1,"IsEthernetFabricEnabled": false},"OptionalComponents": [{"Name": "ReplicationManager","Installed": false}]}
Chassis resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Chapter 2: UCP Director resources 9UCP Director API Reference
Chassis resources
Request Method URIvCenterPrivilege
"List all chassis" below GET /api/chassis UCP View
"Get a chassis" below GET /api/chassis/{CHASSISID} UCP View
"Update chassis firmware"on page 49
POST/api/chassis/{CHASSISID}/firmwareupdates
UCPAdministrator
"Update chassis and bladefirmware" on page 50
POST/api/chassis/{CHASSISID}/servers/firmwareupdates
UCPAdministrator
List all chassis
This HTTP request uses the GET method on the /api/chassis URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body returns an array of properties for each chassis in UCPinventory. Properties for chassis are detailed under the heading "Get achassis" below.
Example: List all chassis
In this example, chassis are listed.
Request HeaderGET https://ucpmanagement.ucp.local/api/chassis HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response BodyThe response body lists all chassis in UCP inventory. An example of chassisdetails is shown under the heading "Get a chassis" below.
Get a chassis
This HTTP request uses the GET method on the /api/chassis/{CHASSISID}URI, where {CHASSISID} specifies the ID of the chassis that is to bereturned.
10 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The chart below details the properties for chassis:
Name Type Notes
(Common properties) See Common properties
MonitorState Collection Collection of monitor states.
GlobalResourceId StringGlobally unique resource Id of thechassis.
MonitorIndicators CollectionCollection of monitor indicators fromchassis sub components.
DisplayName String Display name of the monitor indicator.
IndicatorState String State of the indicator.
IndicatorType String Type of the indicator.
Name String Name of the indicator.
SubGlobalResourceIds StringComma separated list of global IDs ofsub resources, if any.
SubResourceType StringThe resource type of the sub resources,if any.
MonitorMode String
The mode for reporting the SNMP trapsfrom the chassis. This mode applies toall resources of the same type. Values:
• Report
• Off
• Monitor
NumErrors StringNumber of errors totaled fromSubGlobalResourceIds.
NumNotApplicables Int32Number of NAmessages totaled fromSubGlobalResourceIds.
NumOks Int32Number of OKmessages totaled fromSubGlobalResourceIds.
NumUnknowns Int32Number of Unknown messages totaledfrom SubGlobalResourceIds.
NumWarnings Int32Number of Warnings totaled fromSubGlobalResourceIds.
ResourceState String Overall monitor state of the chassis.
Chapter 2: UCP Director resources 11UCP Director API Reference
Chassis resources
Name Type Notes
ResourceType String Always “Chassis” for chassis.
UpdatedDateTime DateTimeDate and Time of the last time anaggregatedmonitor state was compiledfor the chassis.
ChassisInformation CollectionCollection of metadata about thechassis.
AvailableDictionaryVersion StringIf UCP has another version ofDictionary for the chassis, it is shownhere.
AvailableFirmwareVersion StringIf UCP has another version of Firmwarefor the chassis, it is shown here.
AvailableParameterVersion StringIf UCP has another version ofParameter file for the chassis, it isshown here.
BladeInformationList CollectionCollection of information about bladesin the chassis. See subsequent chartsbelow.
ChassisId String Id of the chassis.
ChassisName String Name of the chassis.
Connectivity BooleanWhether management access to thechassis is online and available.
ErrorCount Int32 Number of errors from the chassis.
FanInformationListCollection of information about fans inthe chassis. See subsequent chartsbelow.
Health String
The health status of the chassis.Values:
• Healthy
• Warning
• Critical
• Unknown
InformationCount Int32The number of unconfirmedinformation messages.
LIDColor String
The color of the LID on the front of thechassis. Values:
• Blue
12 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
Name Type Notes
• Unknown
LIDState String
The color of the LID on the front of thechassis. Values:
• On
• Off
• Unknown
LastRefreshed DateTimeThe date and time server elementmanager information was lastrefreshed.
MaintenanceMode BooleanWhether the chassis is in maintenancemode.
ManagementModuleInformationList CollectionCollection of information aboutmanagement modules in the chassis.See subsequent charts below.
ModelName String Model of the chassis.
ModelNumber String Model number of the chassis
ModelType String Model type of the chassis.
PowerState String Power state of the chassis.
PowerSupplyModuleInformationList CollectionCollection of information about thepower supplies in the chassis. Seesubsequent charts below.
SerialNumber String Serial number of the chassis.
SvpDefaultGateway StringDefault gateway used by the chassisSVP (also known asmanagementmodule).
SvpIp StringIP used by the chassis SVP (also knownasmanagement module).
SvpSubnetMask StringSubnet mask used by the chassis SVP(also known asmanagement module).
SvpWebconsoleUrl StringURL for accessing the managementinterface to the SVP.
SwitchInformationList CollectionCollection of information about theswitch modules in the chassis. Seesubsequent charts below.
WarningCount Int32Number of warnings messages fromthe chassis.
HostInformationList CollectionCollection of information about thehosts in the chassis. See thesubheading Get servers.
Chapter 2: UCP Director resources 13UCP Director API Reference
Chassis resources
Blade Information List and HostInformationListSee the heading "Get server" on page 591 for details regarding theproperties of the BladeInformationList and HostInformationList.
FanInformationListName Type Notes
FanInformationList CollectionThe following six line items are repeatedfor each fan in the chassis.
ChassisId StringThe ID of the chassis where the fan isinstalled.
ChassisSerialNumber StringThe serial number of the chassis wherethe fan is installed.
FanSlot Int32 The slot number of the fan.
Health String The fan’s health status.
InstallStatus String The installation status of the fan.
PowerState String The state of fan power.
ManagementModuleInformationListName Type Notes
ManagementModuleInformationList CollectionThe following twenty line items arerepeated for each management modulein the chassis.
Active Boolean
Whether or not the managementmodule is active. The activemanagement module controls thechassis while the other one is on standbyin case the primary fails.
ChassisId StringThe ID of the chassis where themanagement module is installed.
ChassisSerialNumber StringThe serial number of the chassis wherethe management module is installed.
DictionaryVersion String The version of the dictionary file.
FirmwareVersion StringThe version of management modulefirmware.
Health String
The health status of the managementmodule. Values:
• Healthy
• Warning
14 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
Name Type Notes
• Critical
• Unknown
InstallStatus String
Whether or not the managementmodule is installed. Values:
• Installed
• NotInstalled
• Unknown
LidColor String
The color of the LID on the front of themanagement module. Values:
• Blue
• Unknown
LidState String
The state of the LID on the front of themanagement module. Values:
• On
• Off
• Unknown
MaintenanceDefaultGateway StringThe default gateway for themanagement port.
MaintenanceIp String The IP address of the maintenance port.
MaintenanceMode BooleanWhether or not the managementmodule is in maintenance mode.
MaintenanceSubnetMask String The maintenance port‘s subnet mask.
ManagementModuleSlot Int32 The management module slot number.
ModelNumber StringThe model number of the managementmodule.
ParameterVersion StringThe version of the managementmodule’s parameter file.
PowerState StringThe state of management modulepower.
SvpDefaultGateway StringThe default gateway for the SVP (ormanagement module).
SvpIp StringThe IP address of the SVP (ormanagement module).
SvpSubnetMask StringThe subnet mask of the SVP (ormanagement module).
Chapter 2: UCP Director resources 15UCP Director API Reference
Chassis resources
SwitchInformationListName Type Notes
SwitchInformationList CollectionThe following seventeen line items arerepeated for each switch module in thechassis.
ChassisId StringId of the chassis where the switch isinstalled.
ChassisSerialNumber StringSerial Number of the chassis where theswitch is installed.
DefaultGateway String Gateway the switch uses.
FirmwareVersion String Firmware version of the switch.
Health string
Health status of the switch. Values:
• Healthy
• Warning
• Critical
• Unknown
Id String Id of the switch.
InstallStatus
Installation status of the switch. Values:
• Installed
• NotInstalled
• Unknown
Ip StringThe management IP address of switchmodule.
LidColor String
The color of the LID on the front of theswitch module. Values:
• Blue
• Unknown
LidState
The state of the LID on the front of theswitch module. Possible values:
• On
• Off
• Unknown
16 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
Name Type Notes
MaintenanceMode BooleanWhether or not the switch module is inmaintenance mode.
Model String The switch module’s model name.
ModelNumber String Model number of the switch.
PowerState String
Power state of the switch module. Values:
• On
• Off
• Unknown
SerialNumber String The switch module’s serial number.
SubnetMask String Subnet mask used by the switch module.
SwitchSlot Int32The slot number in the chassis where theswitch is installed.
PowerSupplyModuleInformationListName Type Notes
PowerSupplyModuleInformationList CollectionThe following nine items are repeated foreach power supply module in thechassis.
ChassisId StringThe ID of the chassis where the powersupply resides.
ChassisSerialNumber StringThe serial number of the chassis wherethe power supply resides.
Health String
The health status of the power supply.Values:
• Healthy
• Warning
• Critical
• Unknown
InstallStatus String
Whether or not the power supply isinstalled. Values:
• Installed
• NotInstalled
Chapter 2: UCP Director resources 17UCP Director API Reference
Chassis resources
Name Type Notes
• Unknown
ModelNumber String The power supply’s model number.
PowerState String
The state of power supply power. Values:
• On
• Off
• Unknown
PowerSupplyModuleSlot Int32 The power supply slot number.
ProductName String The power supply’s product name.
SerialNumber String The power supply’s serial number.
Example: Get a chassis
The following example uses a GET request toretrieve information about aspecific chassis. This chassis is in a converged environment where switchslots 2 and 3 have pass-through modules.
Request HeaderGET https://ucpmanagement.ucp.local/api/chassis/Hitachi_0_323GG-RE3A1NBX1-Y00000009 HTTP/1.1 Content-Type: application/json;charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ResourceType": "Chassis","GlobalResourceId": "inst.UCP-040121.cmp.1.ch.Hitachi_0_323GG-RE3A1NBXR-Y00000725","InstanceId": "UCP-040121","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/chassis\/Hitachi_0_323GG-RE3A1NBXR-Y00000725"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/chassis"
18 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Chassis&targetId=inst.UCP-040121.cmp.1.ch.Hitachi_0_323GG-RE3A1NBXR-Y00000725&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Chassis&targetId=inst.UCP-040121.cmp.1.ch.Hitachi_0_323GG-RE3A1NBXR-Y00000725&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Chassis&targetId=inst.UCP-040121.cmp.1.ch.Hitachi_0_323GG-RE3A1NBXR-Y00000725&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Chassis&targetId=inst.UCP-040121.cmp.1.ch.Hitachi_0_323GG-RE3A1NBXR-Y00000725&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Chassis&targetId=inst.UCP-040121.cmp.1.ch.Hitachi_0_323GG-RE3A1NBXR-Y00000725&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Chassis&targetId=inst.UCP-040121.cmp.1.ch.Hitachi_0_323GG-RE3A1NBXR-Y00000725&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.UCP-040121.cmp.1.ch.Hitachi_0_323GG-RE3A1NBXR-Y00000725","MonitorIndicators": [{"DisplayName": "Chassis Health","IndicatorState": "Ok","IndicatorType": "Health",
Chapter 2: UCP Director resources 19UCP Director API Reference
Chassis resources
"Name": "ChassisHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Fan Modules","IndicatorState": "Ok","IndicatorType": "Health","Name": "FanModules","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Power Supply Modules","IndicatorState": "Ok","IndicatorType": "Health","Name": "PowerSupplyModules","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Management Modules","IndicatorState": "Ok","IndicatorType": "Health","Name": "ManagementModules","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Servers","IndicatorState": "Ok","IndicatorType": "Composite","Name": "Servers","SubGlobalResourceIds": ["inst.UCP-040121.cmp.1.ser.3e64f18c-6ef4-4bcb-9539-4a735c1bacc6","inst.UCP-040121.cmp.1.ser.1f4b6b4c-45a5-44a9-bcfe-838d81bb3520","inst.UCP-040121.cmp.1.ser.7f0c26ed-b5fc-4848-8a7c-7993d4af8891","inst.UCP-040121.cmp.1.ser.76deac88-b4ca-11e3-aceb-b50b19e83600","inst.UCP-040121.cmp.1.ser.8e9fde4d-2ab0-4404-869f-4aebf3729b4b","inst.UCP-040121.cmp.1.ser.b7aa431c-7368-43d5-94c5-0880d481a401","inst.UCP-040121.cmp.1.ser.2e1f23dd-8193-48d7-b420-91454ef477c8","inst.UCP-040121.cmp.1.ser.19aff2b0-9939-4d16-8239-1b03983db143"],"SubResourceType": "Server"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 0,"NumOks": 12,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok",
20 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"ResourceType": "Chassis","UpdatedDateTime": "4\/25\/2015 12:19:52 AM +00:00"},"ChassisInformation": {"AvailableDictionaryVersion": null,"AvailableFirmwareVersion": null,"AvailableParameterVersion": null,"BladeInformationList": [{"AvailableFirmwareVersion": null,"BmcDefaultGateway": "172.17.92.1","BmcDhcpEnabled": false,"BmcFirmwareVersionCurrent": "04-29","BmcFirmwareVersionPending": "","BmcIp": "172.17.92.11","BmcSubnetMask": "255.255.255.0","BootType": "Custom","ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","ConsoleUri": "https:\/\/172.17.92.11\/","CoresPerCPU": 12,"CpuCacheSize": "30 MB","CpuCacheSizeInMB": 30,"CpuFrequency": "2.7 GHz","CpuFrequencyInGHz": 2.7,"CpuType": "Intel(R) Xeon(R) CPU E5-2697 v2 @ 2.70GHz","CurrentFirmwareVersion": "04-42","CurrentServerProfileId": "46","EfiFirmwareVersionCurrent": "10-65","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 1,"Model": "ONBOARD","PortNumber": 1,"ServerBladeNumber": 0,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:02","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:03","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD",
Chapter 2: UCP Director resources 21UCP Director API Reference
Chassis resources
"DeviceId": "0C00","FunctionNumber": 0,"Model": "ONBOARD","PortNumber": 0,"ServerBladeNumber": 0,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:00","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:01","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}],"Health": "Healthy","InformationCount": 124,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1429920649000-0700)\/","MacType": "Additional","Manufacturer": "HITACHI","MemoryAmount": "256 GB","MemoryAmountInGB": 256,"Model": "Compute Blade 520HB2","ModelNumber": "GG-RV3XGC0B2X1-Y","NicInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 1,"MacAddress": "d0:5f:ce:01:00:02","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 0},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 2,"MacAddress": "d0:5f:ce:01:00:01","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,
22 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"ServerBladeNumber": 0},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 0,"MacAddress": "d0:5f:ce:01:00:00","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 0},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 3,"MacAddress": "d0:5f:ce:01:00:03","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 3,"ServerBladeNumber": 0}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 0,"PartitionValid": true,"PartitionWidth": 1,"PendingFirmwareVersion": "","PowerState": "On","PrimarySlot": 0,"SerialNumber": "323GG-RV3XGC0B2X1-Y00001603","ServerId": "2e1f23dd-8193-48d7-b420-91454ef477c8","ServerUuid": "2e1f23dd-8193-48d7-b420-91454ef477c8","UuidType": "Additional","WarningCount": 0,"WwnType": "Additional"},{"AvailableFirmwareVersion": null,"BmcDefaultGateway": "172.17.92.1","BmcDhcpEnabled": false,"BmcFirmwareVersionCurrent": "04-29",
Chapter 2: UCP Director resources 23UCP Director API Reference
Chassis resources
"BmcFirmwareVersionPending": "","BmcIp": "172.17.92.12","BmcSubnetMask": "255.255.255.0","BootType": "Custom","ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","ConsoleUri": "https:\/\/172.17.92.12\/","CoresPerCPU": 12,"CpuCacheSize": "30 MB","CpuCacheSizeInMB": 30,"CpuFrequency": "2.7 GHz","CpuFrequencyInGHz": 2.7,"CpuType": "Intel(R) Xeon(R) CPU E5-2697 v2 @ 2.70GHz","CurrentFirmwareVersion": "04-42","CurrentServerProfileId": "31","EfiFirmwareVersionCurrent": "10-65","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 0,"Model": "ONBOARD","PortNumber": 0,"ServerBladeNumber": 1,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:28","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:29","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 1,"Model": "ONBOARD","PortNumber": 1,"ServerBladeNumber": 1,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:2A","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:2B","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}],
24 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"Health": "Healthy","InformationCount": 93,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1429920682000-0700)\/","MacType": "Additional","Manufacturer": "HITACHI","MemoryAmount": "256 GB","MemoryAmountInGB": 256,"Model": "Compute Blade 520HB2","ModelNumber": "GG-RV3XGC0B2X1-Y","NicInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 1,"MacAddress": "d0:5f:ce:01:00:2a","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 1},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 2,"MacAddress": "d0:5f:ce:01:00:29","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,"ServerBladeNumber": 1},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 0,"MacAddress": "d0:5f:ce:01:00:28","Model": "ONBOARD",
Chapter 2: UCP Director resources 25UCP Director API Reference
Chassis resources
"PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 1},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 3,"MacAddress": "d0:5f:ce:01:00:2b","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 3,"ServerBladeNumber": 1}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 1,"PartitionValid": true,"PartitionWidth": 1,"PendingFirmwareVersion": "","PowerState": "Off","PrimarySlot": 1,"SerialNumber": "323GG-RV3XGC0B2X1-Y00001604","ServerId": "1f4b6b4c-45a5-44a9-bcfe-838d81bb3520","ServerUuid": "1f4b6b4c-45a5-44a9-bcfe-838d81bb3520","UuidType": "Additional","WarningCount": 0,"WwnType": "Additional"},{"AvailableFirmwareVersion": null,"BmcDefaultGateway": "172.17.92.1","BmcDhcpEnabled": false,"BmcFirmwareVersionCurrent": "04-29","BmcFirmwareVersionPending": "","BmcIp": "172.17.92.13","BmcSubnetMask": "255.255.255.0","BootType": "ESXiStateless","ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","ConsoleUri": "https:\/\/172.17.92.13\/","CoresPerCPU": 12,"CpuCacheSize": "30 MB","CpuCacheSizeInMB": 30,"CpuFrequency": "2.7 GHz","CpuFrequencyInGHz": 2.7,"CpuType": "Intel(R) Xeon(R) CPU E5-2697 v2 @ 2.70GHz",
26 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"CurrentFirmwareVersion": "04-42","CurrentServerProfileId": null,"EfiFirmwareVersionCurrent": "10-65","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 1,"Model": "ONBOARD","PortNumber": 1,"ServerBladeNumber": 2,"WorldWideNodeName": "20:00:00:1F:67:13:A5:6D","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "10:00:00:1F:67:13:A5:6D","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 0,"Model": "ONBOARD","PortNumber": 0,"ServerBladeNumber": 2,"WorldWideNodeName": "20:00:00:1F:67:13:A5:69","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "10:00:00:1F:67:13:A5:69","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}],"Health": "Healthy","InformationCount": 687,"LIDColor": "Blue","LIDState": "On","LastRefreshed": "\/Date(1429920761000-0700)\/","MacType": "Original","Manufacturer": "HITACHI","MemoryAmount": "256 GB","MemoryAmountInGB": 256,"Model": "Compute Blade 520HB2","ModelNumber": "GG-RV3XGC0B2X1-Y","NicInformationList": [{
Chapter 2: UCP Director resources 27UCP Director API Reference
Chassis resources
"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 0,"MacAddress": "00:1f:67:13:a5:68","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 2},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 2,"MacAddress": "00:1f:67:13:a5:69","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,"ServerBladeNumber": 2},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 1,"MacAddress": "00:1f:67:13:a5:6c","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 2},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 3,
28 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"MacAddress": "00:1f:67:13:a5:6d","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 3,"ServerBladeNumber": 2}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 2,"PartitionValid": true,"PartitionWidth": 1,"PendingFirmwareVersion": "","PowerState": "Off","PrimarySlot": 2,"SerialNumber": "323GG-RV3XGC0B2X1-Y00001605","ServerId": "76deac88-b4ca-11e3-aceb-b50b19e83600","ServerUuid": "76deac88-b4ca-11e3-aceb-b50b19e83600","UuidType": "Original","WarningCount": 0,"WwnType": "Original"},{"AvailableFirmwareVersion": null,"BmcDefaultGateway": "172.17.92.1","BmcDhcpEnabled": false,"BmcFirmwareVersionCurrent": "04-29","BmcFirmwareVersionPending": "","BmcIp": "172.17.92.14","BmcSubnetMask": "255.255.255.0","BootType": "ESXiStateless","ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","ConsoleUri": "https:\/\/172.17.92.14\/","CoresPerCPU": 12,"CpuCacheSize": "30 MB","CpuCacheSizeInMB": 30,"CpuFrequency": "2.7 GHz","CpuFrequencyInGHz": 2.7,"CpuType": "Intel(R) Xeon(R) CPU E5-2697 v2 @ 2.70GHz","CurrentFirmwareVersion": "04-42","CurrentServerProfileId": "14","EfiFirmwareVersionCurrent": "10-65","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 0,
Chapter 2: UCP Director resources 29UCP Director API Reference
Chassis resources
"Model": "ONBOARD","PortNumber": 0,"ServerBladeNumber": 3,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:30","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:31","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 1,"Model": "ONBOARD","PortNumber": 1,"ServerBladeNumber": 3,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:32","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:33","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}],"Health": "Healthy","InformationCount": 152,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1429920669000-0700)\/","MacType": "Additional","Manufacturer": "HITACHI","MemoryAmount": "256 GB","MemoryAmountInGB": 256,"Model": "Compute Blade 520HB2","ModelNumber": "GG-RV3XGC0B2X1-Y","NicInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 3,"MacAddress": "d0:5f:ce:01:00:33","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 3,"ServerBladeNumber": 3
30 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 0,"MacAddress": "d0:5f:ce:01:00:30","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 3},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 1,"MacAddress": "d0:5f:ce:01:00:32","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 3},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 2,"MacAddress": "d0:5f:ce:01:00:31","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,"ServerBladeNumber": 3}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 3,"PartitionValid": true,"PartitionWidth": 1,"PendingFirmwareVersion": "",
Chapter 2: UCP Director resources 31UCP Director API Reference
Chassis resources
"PowerState": "On","PrimarySlot": 3,"SerialNumber": "323GG-RV3XGC0B2X1-Y00001606","ServerId": "19aff2b0-9939-4d16-8239-1b03983db143","ServerUuid": "19aff2b0-9939-4d16-8239-1b03983db143","UuidType": "Additional","WarningCount": 0,"WwnType": "Additional"},{"AvailableFirmwareVersion": null,"BmcDefaultGateway": "172.17.92.1","BmcDhcpEnabled": false,"BmcFirmwareVersionCurrent": "04-29","BmcFirmwareVersionPending": "","BmcIp": "172.17.92.16","BmcSubnetMask": "255.255.255.0","BootType": "ESXiStateless","ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","ConsoleUri": "https:\/\/172.17.92.16\/","CoresPerCPU": 12,"CpuCacheSize": "30 MB","CpuCacheSizeInMB": 30,"CpuFrequency": "2.7 GHz","CpuFrequencyInGHz": 2.7,"CpuType": "Intel(R) Xeon(R) CPU E5-2697 v2 @ 2.70GHz","CurrentFirmwareVersion": "04-42","CurrentServerProfileId": "2","EfiFirmwareVersionCurrent": "10-65","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 0,"Model": "ONBOARD","PortNumber": 0,"ServerBladeNumber": 5,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:05","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:04","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "10Gb Onboard LAN","CardSlot": 1,
32 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 1,"Model": "ONBOARD","PortNumber": 1,"ServerBladeNumber": 5,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:07","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:06","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}],"Health": "Healthy","InformationCount": 42,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1429920659000-0700)\/","MacType": "Additional","Manufacturer": "HITACHI","MemoryAmount": "256 GB","MemoryAmountInGB": 256,"Model": "Compute Blade 520HB2","ModelNumber": "GG-RV3XGC0B2X1-Y","NicInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 2,"MacAddress": "d0:5f:ce:01:00:05","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,"ServerBladeNumber": 5},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 3,"MacAddress": "d0:5f:ce:01:00:07","Model": "ONBOARD","PhysicalPortNumber": 1,
Chapter 2: UCP Director resources 33UCP Director API Reference
Chassis resources
"PortNumber": 3,"ServerBladeNumber": 5},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 1,"MacAddress": "d0:5f:ce:01:00:06","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 5},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 0,"MacAddress": "d0:5f:ce:01:00:04","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 5}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 5,"PartitionValid": true,"PartitionWidth": 1,"PendingFirmwareVersion": "","PowerState": "On","PrimarySlot": 5,"SerialNumber": "323GG-RV3XGC0B2X1-Y00001607","ServerId": "7f0c26ed-b5fc-4848-8a7c-7993d4af8891","ServerUuid": "7f0c26ed-b5fc-4848-8a7c-7993d4af8891","UuidType": "Additional","WarningCount": 0,"WwnType": "Additional"},{"AvailableFirmwareVersion": null,"BmcDefaultGateway": "172.17.92.1","BmcDhcpEnabled": false,
34 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"BmcFirmwareVersionCurrent": "04-29","BmcFirmwareVersionPending": "","BmcIp": "172.17.92.15","BmcSubnetMask": "255.255.255.0","BootType": "ESXiStateless","ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","ConsoleUri": "https:\/\/172.17.92.15\/","CoresPerCPU": 12,"CpuCacheSize": "30 MB","CpuCacheSizeInMB": 30,"CpuFrequency": "2.7 GHz","CpuFrequencyInGHz": 2.7,"CpuType": "Intel(R) Xeon(R) CPU E5-2697 v2 @ 2.70GHz","CurrentFirmwareVersion": "04-42","CurrentServerProfileId": "15","EfiFirmwareVersionCurrent": "10-65","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 0,"Model": "ONBOARD","PortNumber": 0,"ServerBladeNumber": 4,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:34","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:35","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 1,"Model": "ONBOARD","PortNumber": 1,"ServerBladeNumber": 4,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:36","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:37","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}
Chapter 2: UCP Director resources 35UCP Director API Reference
Chassis resources
],"Health": "Healthy","InformationCount": 34,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1429920654000-0700)\/","MacType": "Additional","Manufacturer": "HITACHI","MemoryAmount": "256 GB","MemoryAmountInGB": 256,"Model": "Compute Blade 520HB2","ModelNumber": "GG-RV3XGC0B2X1-Y","NicInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 1,"MacAddress": "d0:5f:ce:01:00:36","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 4},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 2,"MacAddress": "d0:5f:ce:01:00:35","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,"ServerBladeNumber": 4},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 3,"MacAddress": "d0:5f:ce:01:00:37",
36 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 3,"ServerBladeNumber": 4},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 0,"MacAddress": "d0:5f:ce:01:00:34","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 4}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 4,"PartitionValid": true,"PartitionWidth": 1,"PendingFirmwareVersion": "","PowerState": "On","PrimarySlot": 4,"SerialNumber": "323GG-RV3XGC0B2X1-Y00001608","ServerId": "b7aa431c-7368-43d5-94c5-0880d481a401","ServerUuid": "b7aa431c-7368-43d5-94c5-0880d481a401","UuidType": "Additional","WarningCount": 0,"WwnType": "Additional"},{"AvailableFirmwareVersion": null,"BmcDefaultGateway": "172.17.92.1","BmcDhcpEnabled": false,"BmcFirmwareVersionCurrent": "04-29","BmcFirmwareVersionPending": "","BmcIp": "172.17.92.17","BmcSubnetMask": "255.255.255.0","BootType": "Custom","ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","ConsoleUri": "https:\/\/172.17.92.17\/","CoresPerCPU": 12,"CpuCacheSize": "30 MB","CpuCacheSizeInMB": 30,"CpuFrequency": "2.7 GHz","CpuFrequencyInGHz": 2.7,
Chapter 2: UCP Director resources 37UCP Director API Reference
Chassis resources
"CpuType": "Intel(R) Xeon(R) CPU E5-2697 v2 @ 2.70GHz","CurrentFirmwareVersion": "04-42","CurrentServerProfileId": "61","EfiFirmwareVersionCurrent": "10-65","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 0,"Model": "ONBOARD","PortNumber": 0,"ServerBladeNumber": 6,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:08","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:09","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 1,"Model": "ONBOARD","PortNumber": 1,"ServerBladeNumber": 6,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:0A","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:0B","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}],"Health": "Healthy","InformationCount": 128,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1429920664000-0700)\/","MacType": "Additional","Manufacturer": "HITACHI","MemoryAmount": "256 GB","MemoryAmountInGB": 256,"Model": "Compute Blade 520HB2","ModelNumber": "GG-RV3XGC0B2X1-Y","NicInformationList": [
38 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 2,"MacAddress": "d0:5f:ce:01:00:09","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,"ServerBladeNumber": 6},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 0,"MacAddress": "d0:5f:ce:01:00:08","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 6},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 1,"MacAddress": "d0:5f:ce:01:00:0a","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 6},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,
Chapter 2: UCP Director resources 39UCP Director API Reference
Chassis resources
"FunctionNumber": 3,"MacAddress": "d0:5f:ce:01:00:0b","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 3,"ServerBladeNumber": 6}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 6,"PartitionValid": true,"PartitionWidth": 1,"PendingFirmwareVersion": "","PowerState": "On","PrimarySlot": 6,"SerialNumber": "323GG-RV3XGC0B2X1-Y00001609","ServerId": "3e64f18c-6ef4-4bcb-9539-4a735c1bacc6","ServerUuid": "3e64f18c-6ef4-4bcb-9539-4a735c1bacc6","UuidType": "Additional","WarningCount": 0,"WwnType": "Additional"},{"AvailableFirmwareVersion": null,"BmcDefaultGateway": "172.17.92.1","BmcDhcpEnabled": false,"BmcFirmwareVersionCurrent": "04-29","BmcFirmwareVersionPending": "","BmcIp": "172.17.92.18","BmcSubnetMask": "255.255.255.0","BootType": "ESXiStateless","ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","ConsoleUri": "https:\/\/172.17.92.18\/","CoresPerCPU": 10,"CpuCacheSize": "25 MB","CpuCacheSizeInMB": 25,"CpuFrequency": "3 GHz","CpuFrequencyInGHz": 3,"CpuType": "Intel(R) Xeon(R) CPU E5-2690 v2 @ 3.00GHz","CurrentFirmwareVersion": "04-42","CurrentServerProfileId": "7","EfiFirmwareVersionCurrent": "10-65","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00",
40 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"FunctionNumber": 1,"Model": "ONBOARD","PortNumber": 1,"ServerBladeNumber": 7,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:1B","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:1A","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","DeviceId": "0C00","FunctionNumber": 0,"Model": "ONBOARD","PortNumber": 0,"ServerBladeNumber": 7,"WorldWideNodeName": "24:00:D0:5F:CE:01:00:19","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:01:00:18","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}],"Health": "Healthy","InformationCount": 86,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1429920644000-0700)\/","MacType": "Additional","Manufacturer": "HITACHI","MemoryAmount": "256 GB","MemoryAmountInGB": 256,"Model": "Compute Blade 520HB2","ModelNumber": "GG-RV3XGC0B2X1-Y","NicInformationList": [{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 2,"MacAddress": "d0:5f:ce:01:00:19","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,
Chapter 2: UCP Director resources 41UCP Director API Reference
Chassis resources
"ServerBladeNumber": 7},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 1,"MacAddress": "d0:5f:ce:01:00:1a","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 7},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 3,"MacAddress": "d0:5f:ce:01:00:1b","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 3,"ServerBladeNumber": 7},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0C00","Duplication": false,"FunctionNumber": 0,"MacAddress": "d0:5f:ce:01:00:18","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 7}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 7,"PartitionValid": true,"PartitionWidth": 1,
42 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"PendingFirmwareVersion": "","PowerState": "On","PrimarySlot": 7,"SerialNumber": "323GG-RV3XGC0B2X1-Y00002983","ServerId": "8e9fde4d-2ab0-4404-869f-4aebf3729b4b","ServerUuid": "8e9fde4d-2ab0-4404-869f-4aebf3729b4b","UuidType": "Additional","WarningCount": 0,"WwnType": "Additional"}],"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisName": "RE3A1NBXR-Y000725","Connectivity": true,"ErrorCount": 0,"FanInformationList": [{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","FanSlot": 0,"Health": "Healthy","InstallStatus": "Installed","PowerState": "On"},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","FanSlot": 1,"Health": "Healthy","InstallStatus": "Installed","PowerState": "On"},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","FanSlot": 2,"Health": "Healthy","InstallStatus": "Installed","PowerState": "On"},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","FanSlot": 3,"Health": "Healthy","InstallStatus": "Installed","PowerState": "On"},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","FanSlot": 4,"Health": "Healthy",
Chapter 2: UCP Director resources 43UCP Director API Reference
Chassis resources
"InstallStatus": "Installed","PowerState": "On"},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","FanSlot": 5,"Health": "Healthy","InstallStatus": "Installed","PowerState": "On"}],"Health": "Healthy","InformationCount": 1532,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1429920644000-0700)\/","MaintenanceMode": false,"ManagementModuleInformationList": [{"Active": true,"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","DictionaryVersion": "A0138","FirmwareVersion": "A0241-B-9901","Health": "Healthy","InstallStatus": "Installed","LidColor": "Blue","LidState": "Off","MaintenanceDefaultGateway": "0.0.0.0","MaintenanceIp": "192.168.254.1","MaintenanceMode": false,"MaintenanceSubnetMask": "255.255.255.0","ManagementModuleSlot": 0,"ModelNumber": "GG-BE3SVP1X1-Y","ParameterVersion": "1019","PowerState": "On","SvpDefaultGateway": "172.17.92.1","SvpIp": "172.17.92.10","SvpSubnetMask": "255.255.255.0"},{"Active": false,"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","DictionaryVersion": "A0138","FirmwareVersion": "A0241-B-9901","Health": "Healthy","InstallStatus": "Installed","LidColor": "Blue","LidState": "Off","MaintenanceDefaultGateway": "0.0.0.0","MaintenanceIp": "192.168.254.2",
44 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"MaintenanceMode": false,"MaintenanceSubnetMask": "255.255.255.0","ManagementModuleSlot": 1,"ModelNumber": "GG-BE3SVP1X1-Y","ParameterVersion": "1019","PowerState": "On","SvpDefaultGateway": "172.17.92.1","SvpIp": "172.17.92.10","SvpSubnetMask": "255.255.255.0"}],"ModelName": "RE3A1NBXR-Y000725","ModelNumber": "GG-RE3A1NBXR-Y","ModelType": "Hitachi Compute Blade 500","PowerState": "On","PowerSupplyModuleInformationList": [{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","Health": "Healthy","InstallStatus": "Installed","ModelNumber": "323-5814541-030","PowerState": "On","PowerSupplyModuleSlot": 0,"ProductName": "SWR210002-U","SerialNumber": "140356995"},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","Health": "Healthy","InstallStatus": "Installed","ModelNumber": "323-5814541-030","PowerState": "On","PowerSupplyModuleSlot": 1,"ProductName": "SWR210002-U","SerialNumber": "140356932"},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","Health": "Healthy","InstallStatus": "Installed","ModelNumber": "323-5814541-030","PowerState": "On","PowerSupplyModuleSlot": 2,"ProductName": "SWR210002-U","SerialNumber": "140356931"},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","Health": "Healthy",
Chapter 2: UCP Director resources 45UCP Director API Reference
Chassis resources
"InstallStatus": "Installed","ModelNumber": "323-5814541-030","PowerState": "On","PowerSupplyModuleSlot": 3,"ProductName": "SWR210002-U","SerialNumber": "140457155"}],"SerialNumber": "323GG-RE3A1NBXR-Y00000725","SvpDefaultGateway": "172.17.92.1","SvpIp": "172.17.92.10","SvpSubnetMask": "255.255.255.0","SvpWebconsoleUrl": "https:\/\/172.17.92.10\/","SwitchInformationList": [{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","DefaultGateway": "0.0.0.0","FirmwareVersion": "","Health": "Healthy","Id": "Hitachi_0_323-06VHDE1G01K","InstallStatus": "Installed","Ip": "0.0.0.0","LidColor": "Blue","LidState": "Off","MaintenanceMode": false,"Model": "10Gb LAN pass through module","ModelNumber": "GG-BE3LPS2X1-Y","PowerState": "On","SerialNumber": "323-06VHDE1G01K","SubnetMask": "0.0.0.0","SwitchSlot": 0},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","DefaultGateway": "0.0.0.0","FirmwareVersion": "","Health": "Healthy","Id": "Hitachi_0_323-06VHDE1G01M","InstallStatus": "Installed","Ip": "0.0.0.0","LidColor": "Blue","LidState": "Off","MaintenanceMode": false,"Model": "10Gb LAN pass through module","ModelNumber": "GG-BE3LPS2X1-Y","PowerState": "On","SerialNumber": "323-06VHDE1G01M","SubnetMask": "0.0.0.0","SwitchSlot": 1},{
46 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","DefaultGateway": "","FirmwareVersion": "","Health": "Unknown","Id": "","InstallStatus": "NotInstalled","Ip": "","LidColor": "Blue","LidState": "On","MaintenanceMode": false,"Model": "","ModelNumber": "","PowerState": "Unknown","SerialNumber": "","SubnetMask": "","SwitchSlot": 2},{"ChassisId": "Hitachi_0_323GG-RE3A1NBXR-Y00000725","ChassisSerialNumber": "323GG-RE3A1NBXR-Y00000725","DefaultGateway": "","FirmwareVersion": "","Health": "Unknown","Id": "","InstallStatus": "NotInstalled","Ip": "","LidColor": "Blue","LidState": "On","MaintenanceMode": false,"Model": "","ModelNumber": "","PowerState": "Unknown","SerialNumber": "","SubnetMask": "","SwitchSlot": 3}],"WarningCount": 11},"HostInformationList": [{"ApplyingTemplate": false,"ClusterId": null,"ClusterName": null,"CurrentImageId": 24,"CurrentImageName": "CentOS-TryAgain6.6","CurrentImageType": "Linux","HostId": "","HostName": "hitachiblade1","HostUuid": "2E1F23DD-8193-48D7-B420-91454EF477C8","InMaintenanceMode": false},
Chapter 2: UCP Director resources 47UCP Director API Reference
Chassis resources
{"ApplyingTemplate": false,"ClusterId": null,"ClusterName": null,"CurrentImageId": 0,"CurrentImageName": null,"CurrentImageType": "Custom","HostId": "","HostName": "","HostUuid": "1f4b6b4c-45a5-44a9-bcfe-838d81bb3520","InMaintenanceMode": false},{"ApplyingTemplate": false,"ClusterId": null,"ClusterName": null,"CurrentImageId": 0,"CurrentImageName": null,"CurrentImageType": "EsxiStateless","HostId": "","HostName": "","HostUuid": "76deac88-b4ca-11e3-aceb-b50b19e83600","InMaintenanceMode": false},{"ApplyingTemplate": false,"ClusterId": "domain-c219","ClusterName": "EsxiStatelessCluster-1386593096","CurrentImageId": 4,"CurrentImageName": "HitachiESXiImage-60-20150313-520HB3","CurrentImageType": "EsxiStateless","HostId": "host-218","HostName": "172.17.92.43","HostUuid": "19aff2b0-9939-4d16-8239-1b03983db143","InMaintenanceMode": true},{"ApplyingTemplate": false,"ClusterId": null,"ClusterName": null,"CurrentImageId": 4,"CurrentImageName": "HitachiESXiImage-60-20150313-520HB3","CurrentImageType": "EsxiStateless","HostId": "host-283","HostName": "hitachiblade2.ucp.local","HostUuid": "7f0c26ed-b5fc-4848-8a7c-7993d4af8891","InMaintenanceMode": false},{"ApplyingTemplate": false,"ClusterId": "domain-c219","ClusterName": "EsxiStatelessCluster-1386593096","CurrentImageId": 4,
48 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
"CurrentImageName": "HitachiESXiImage-60-20150313-520HB3","CurrentImageType": "EsxiStateless","HostId": "host-215","HostName": "172.17.92.44","HostUuid": "b7aa431c-7368-43d5-94c5-0880d481a401","InMaintenanceMode": true},{"ApplyingTemplate": false,"ClusterId": null,"ClusterName": null,"CurrentImageId": 18,"CurrentImageName": "CentOS6.6","CurrentImageType": "Linux","HostId": "","HostName": "Linux_LOMIP_172.17.92.17","HostUuid": "3e64f18c-6ef4-4bcb-9539-4a735c1bacc6","InMaintenanceMode": false},{"ApplyingTemplate": false,"ClusterId": null,"ClusterName": null,"CurrentImageId": 3,"CurrentImageName": "HitachiESXiImage-60-20150313-520HB2","CurrentImageType": "EsxiStateless","HostId": "host-322","HostName": "hitachiblade7.ucp.local","HostUuid": "8e9fde4d-2ab0-4404-869f-4aebf3729b4b","InMaintenanceMode": false}]}]
Update chassis firmware
This HTTP request uses the POST method on URI: /api/chassis/{CHASSISID}/firmwareupdates.
Chassis firmware updates could include one or all three of the followingtypes: Dictionary, firmware, equipment parameter. If the pending firmwareversions are different from existing firmware on the chassis SVP, then thepending versions will be applied. The versions may be older or newer.
In vCenter, the UCP Server Administrator privilege is required.
The request body for this API must be empty.
Chapter 2: UCP Director resources 49UCP Director API Reference
Chassis resources
When the request succeeds, the response body consists of an array of theobjects related to the job for updating chassis firmware. The job will containdifferent events per each firmware file updated. Job details and results canbe seen with "Get UCP job" on page 439.
Example: Update chassis firmware
Request HeaderPOST https://ucpmanagement.ucp.local/api/chassis/Hitachi_0_323GG-RE3A1NBX1-Y00000015/firmwareupdates HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update chassis firmware".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Update chassis and blade firmware
This HTTP request uses the POST method on URI: /api/chassis/{CHASSISID}/servers/firmwareupdates.
This API first checks if UCP has new firmware for the chassis. This will beupdated first. Then, if there are updates for the blades, these will beupdated next. As with chassis, the “updates” on blades may be older ornewer than the version of firmware currently on the blades. This API isuseful for resetting all blades in a chassis to the same version in case somewere at different levels.
In vCenter, the UCP Server Administrator privilege is required.
The request body for this API must be empty.
When the request succeeds, the response body consists of an array of theobjects related to the job for updating chassis and blade firmware. The jobwill contain different events per each firmware file updated. Job details andresults can be seen with "Get UCP job" on page 439.
50 Chapter 2: UCP Director resources
UCP Director API Reference
Chassis resources
Example: Update chassis and server firmware
Request HeaderPOST https://ucpmanagement.ucp.local/api/chassis/Hitachi_0_323GG-RE3A1NBX1-Y00000009/servers/firmwareupdates HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update chassis and server firmware".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Cluster resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List clusters" on the nextpage
GET /api/clusters UCP View
"Get cluster" on page 54 GET /api/clusters/{CLUSTERID} UCP View
"Change ESXi image usedby a cluster" on page 55
PUT /api/clusters/{CLUSTERID}UCP ServerAdministrator
"Create cluster withservice template" onpage 56
POST /api/clustersUCP SystemAdministrator
"Attach volume tocluster" on page 58
POST/api/clusters/{CLUSTERID}/attachvolume
UCP SystemAdministrator
"Detach volume fromcluster" on page 60
POST/api/clusters/{CLUSTERID}/detachvolume
UCP SystemAdministrator
"Create and attachvolume to cluster" onpage 61
POST/api/clusters/{CLUSTERID}/createandattachvolume
UCP SystemAdministrator
Chapter 2: UCP Director resources 51UCP Director API Reference
Cluster resources
Request Method URIvCenterPrivilege
"Get servers for a cluster"on page 62
GET/api/clusters/servers?count={COUNT}
UCP SystemAdministrator
"Deploy cluster" onpage 63
POST /api/clusters/{CLUSTERID}/deployUCP ServerAdministrator
"Get cluster networks" onpage 64
GET/api/clusters/{CLUSTERID}/networks
UCP NetworkAdministrator
"Apply cluster networkVLANs to Ethernetswitches" on page 66
POST/api/clusters/{CLUSTERID}/networks/configurevlan
UCP NetworkAdministrator
List clusters
This HTTP request uses the GET method on the /api/clusters URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body contains an array of properties for each ESXi cluster inthe UCP inventory. Properties for clusters are detailed under "Get cluster"on page 54.
Example: List all clusters
Request HeaderGET https://ucpmanagement.ucp.local/api/clusters HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "domain-c246","ResourceType": "Cluster","GlobalResourceId": "inst.UCP-123-456-789.vmgr.1.clu.domain-c246","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/clusters\/domain-c246"
52 Chapter 2: UCP Director resources
UCP Director API Reference
Cluster resources
},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/clusters"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=self%7Csubcomponent"}],"Name": "TestCluster","ServerUuids": ["734c28cb-b459-11e1-9ad6-db6dbff1fa28","33318c64-b418-11e1-abe6-9187b4949878"]}]
Chapter 2: UCP Director resources 53UCP Director API Reference
Cluster resources
Get cluster
This HTTP request uses the GET method on the /api/clusters/{CLUSTERID}URI, where {CLUSTERID} specifies the ID of the cluster that is to bereturned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
Name Type Notes
(Common properties) See Common properties
Name String The name of the cluster
ServerUuidsArray ofStrings
List of the IDs of the servers that are in thecluster. Each IDmay be used to identify aserver in a Get server request.
Example: Get a cluster
Request HeaderGET https://ucpmanagement.ucp.local/api/clusters/domain-c246 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "domain-c246","ResourceType": "Cluster","GlobalResourceId": "inst.UCP-123-456-789.vmgr.1.clu.domain-c246","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/clusters\/domain-c246"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/clusters"
54 Chapter 2: UCP Director resources
UCP Director API Reference
Cluster resources
},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Cluster&targetId=inst.UCP-123-456-789.vmgr.1.clu.domain-c246&relation=self%7Csubcomponent"}],"Name": "TestCluster","ServerUuids": ["734c28cb-b459-11e1-9ad6-db6dbff1fa28","33318c64-b418-11e1-abe6-9187b4949878"]}}
Change ESXi image used by a cluster
This request uses the PUT method on the /api/clusters/{CLUSTERID} URI.
Chapter 2: UCP Director resources 55UCP Director API Reference
Cluster resources
The image specified in the payload will be assigned as the Pending Imagefor the cluster. UCP creates a new Auto Deploy rule for each individualserver in the cluster. (Applicable only to clusters that use stateless ESXi.)The next step is to reboot the servers to the new image. This can be donewith POST /api/clusters/{CLUSTERID}.
UCP Server Administrator privilege is required.
The body consists of a string value with the new ESXi image.
Name Type Notes
ImageId StringSpecifies the ESXi image that should be setas the Pending image for the cluster. Onlyapplicable to ESXi host clusters
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Change cluster imageRequest HeaderPUT https://ucpmanagement.ucp.local/api/clusters/domain-c108 HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"ImageId":"5"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Change cluster pending ESXi image".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Create cluster with service template
This HTTP request uses the POST method on the /api/clusters URI. An ESXicluster service template is required and a server profile is required for eachserver in the cluster. If using any HB3 blade, all hosts in the cluster must beHB3.
The UCP System Administrator privilege is required.
56 Chapter 2: UCP Director resources
UCP Director API Reference
Cluster resources
The following set of data is sent in the request for creating a cluster with aservice template.
Name Type Notes
ClusterParentId String
The Id of the parent object under which tocreate the cluster in vSphere.ClusterParentId and ClusterParentType areboth required.
ClusterParentType String
The type of object under which to createthe cluster in vSphere. To discover these,use GET /api/servers/hierarchy. Applicableobjects are:
• Folder
• Datacenter
Name String User-supplied name for the cluster.
ServersToUse ObjectContainer for ServerUuid, VmotionIp,VmotionSubnetMask and serverProfileId.
ServerProfileId Number
ID number of the server profile ID to applyto the server. If the server already has aserver profile applied, be sure to add thatprofile’s ID in the payload for this server.
ServerUuid String
Server Uuid to add to the cluster. Minimumof 3 servers are required if the clusterservice template says to enable vSphere’sHA on the cluster.
VmotionIp String vMotion IP address to use for the server.
VmotionSubnetMask String
Subnet mask to use with the vMotion IPaddress. Subnet mask must be of thecorrect class for the supplied vMotion IPaddress.
ServiceTemplateId String
Id of the cluster service template which willbe applied to the specified servers. Thecluster service template contains otherdetails for the cluster such as the bootimage and VLAN Ids.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Chapter 2: UCP Director resources 57UCP Director API Reference
Cluster resources
Example: Create a three node cluster with a cluster service templateAn ESXi cluster is created when an ESXi cluster service template and serverprofiles are applied to servers.
Request HeaderPOST https://ucpmanagement.ucp.local/api/clusters HTTP/1.1 Content-Type:application/json; charset=utf-8
Request Body{"ClusterParentId":"group-h9","ClusterParentType":"Folder","Name":"Example HA Cluster","ServersToUse":[{"ServerProfileId":7,"ServerUuid":"b30a6875-4afd-4aa3-bfda-e9b59ab6cf92","VmotionIp":"10.21.21.101","VmotionSubnetMask":"255.255.255.0"},{"ServerProfileId":8,"ServerUuid":"c922e98a-6953-4970-9056-6fe061cb8874","VmotionIp":"10.21.21.102","VmotionSubnetMask":"255.255.255.0"},{"ServerProfileId":9,"ServerUuid":"32dc42b3-3677-11e2-aaa4-d503469e48e5","VmotionIp":"10.21.21.103","VmotionSubnetMask":"255.255.255.0"}],"ServiceTemplateId":"1"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Create cluster from service template".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Attach volume to cluster
This HTTP request uses the POST method on the /api/clusters/{CLUSTERID}/attachvolume URI, where {CLUSTERID} specifies the ID ofthe server to which the volume is to be attached.
The UCP System Administrator privilege is required.
58 Chapter 2: UCP Director resources
UCP Director API Reference
Cluster resources
This request body consists of the properties detailed in the following table.
Name Type Notes
StorageSystemId StringSpecifies the ID of the storage systemwith the volume that is to be attached.
VolumeId StringSpecifies the ID of the volume that is to beattached.
StorageSystemPortIdsArray ofStrings
Optionally specifies four IDs of storageports to be used for volume paths. If notspecified, UCP will select ports with thefewest paths.There must be one odd andone even port for each fabric.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Attach a volume to a clusterRequest HeaderPOST https://ucpmanagement.ucp.local/api/clusters/domain-c1469/attachvolume HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body[{"StorageSystemId": "93040480","VolumeId": "32","StorageSystemPortIds": null}]
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Attach an existing volume to a cluster".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Chapter 2: UCP Director resources 59UCP Director API Reference
Cluster resources
Detach volume from cluster
This HTTP request uses the POST method on the /api/clusters/{CLUSTERID}/detachvolume URI, where {CLUSTERID} specifies the ID ofthe cluster from which the volume is to be detached.
The UCP System Administrator privilege is required.
This request body consists of the properties in the following table.
Name Type Notes
StorageSystemId StringThe ID of the storage system containingthe volume to be detached.
VolumeId StringThe ID of the volume that is to bedetached.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Detach a volume from a clusterRequest HeaderPOST https://ucpmanagement.ucp.local/api/clusters/domain-c1459/detachvolume HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"StorageSystemId": "93040480","VolumeId": "31"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Detach a volume from a cluster".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
60 Chapter 2: UCP Director resources
UCP Director API Reference
Cluster resources
Create and attach volume to cluster
This HTTP request uses the POST method on the /api/clusters/{CLUSTERID}/createandattachvolume URI, where {CLUSTERID} specifiesthe ID of the cluster to which the volume is to be attached.
In vCenter, the UCP Storage Administrator privilege is required
This request body consists of the properties in the following chart.
Name Type Notes
PoolId StringSpecifies the ID of the storage pool that isto contain the new volume.
VolumeSizeInBytes DoubleSpecifies the size of the new volume. Validrange: 1288490188 – 65970693734400bytes (1.12 GB – 59.99 TB).
ShouldFormat BooleanSpecifies whether the volume is to beformatted. VMFS is the default format.When true, VolumeName is required.
StorageSystemId StringSpecifies the ID of the storage system thatis to contain the new volume.
StorageSystemPortIdsArray ofStrings
Optionally specifies four IDs of storageports to be used for volume paths. If notspecified, UCP will select ports with thefewest paths. There must be one odd andone even port for each fabric.
VolumeName StringThe name of the new volume. Requiredwhen FormatVolume is true.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Create and attach a new volume to a clusterRequest HeaderPOST https://ucpmanagement.ucp.local/api/clusters/domain-c1469/createandattachvolume HTTP/1.1 Content-Type: application/json;charset=utf-8
Request Body{"PoolId": "2",
Chapter 2: UCP Director resources 61UCP Director API Reference
Cluster resources
"VolumeSizeInBytes": 214748364800,"ShouldFormat": true,"StorageSystemId": "93040480","StorageSystemPortIds": null,"VolumeName": "HRServices"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Create a new volume and attach it to acluster".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get servers for a cluster
This HTTP request uses the GET method on the/api/clusters/servers?count={COUNT} URI. It collects a list of suggestedservers for combining into a vSphere cluster.
In vCenter, the UCP Administrator privilege is required.
The body for this request must be empty.
When the request succeeds, a list of servers is returned. The quantity ofservers will match the {COUNT} value from the URI. Be aware that UCPmight suggest a combination of blade models. However, HB3 blades cannotbe combined with HB2 or HB1 blades in the same cluster.
Servers must be:
• Either using a hypervisor server profile or have no server profile applied
• If running ESXi, it must be in maintenance mode
• Having no storage attached
• Not in a cluster
• If using any HB3 blades, they must all be HB3 blades.
UCP will suggest servers from multiple chassis. The high availability ofclusters is enhanced when servers are placed in different chassis.
62 Chapter 2: UCP Director resources
UCP Director API Reference
Cluster resources
When there are not enough servers matching the listed criteria above, anerror message will be returned. Make manual adjustments to hosts andthen try the command again.
If using servers with hypervisor server profiles already applied, the payloadwhen creating the cluster must include the ID numbers of those serverprofiles.
The properties of each server in the response body are detailed in thesection for Get server.
Example: Get 3 servers for a cluster
Request HeaderGET https://ucpmanagement.ucp.local/api/clusters/servers?count=3HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response BodyA collection of three servers is returned.
See example under the section Get server.
Deploy cluster
This HTTP request uses the POST method on the /api/clusters/{CLUSTERID} URI. It deploys the pending ESXi image to the hosts in thespecified cluster by placing one host into maintenance mode, rebooting it,detecting that the host has exited maintenance mode, and repeating on thenext server.
The UCP System Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Chapter 2: UCP Director resources 63UCP Director API Reference
Cluster resources
Example: Deploy clusterRequest HeaderPOST https://ucpmanagement.ucp.local/api/clusters/domain-c108/deployHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Deploy ESXi image to a cluster".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get cluster networks
This HTTP request uses the GET method on the /api/clusters/{CLUSTERID}/networks URI, where {CLUSTERID} specifies the ID of the cluster. Theuplink configuration is returned for each host in the cluster.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body contains an array of properties for each host uplinkconfiguration. Properties of host uplink configurations are detailed in thefollowing table.
Name Type Notes
Id String Identifies the server.
UplinkConfigurationsArray ofObjects
Reports details for each uplink from eachhost in the cluster.
ConnectedEthernetSwitchPort Object
Details for the switch port on which thehost uplink is connected.Null if the hostuplink is not connected to an accessswitch.
PortId String Identifies the switch port.
SwitchId String Identifies the switch.
Vlans StringThe comma delimited list of VLANs on theconnected switch port.
64 Chapter 2: UCP Director resources
UCP Director API Reference
Cluster resources
Name Type Notes
Name String The name of the host uplink.
Vlans StringThe comma delimited list of VLANs on thehost uplink.
WhatIfConfiguredSwitchPortVlans StringThe VLANs that would be set on theEthernet port if configured by UCPDirector.VLANs are added, not removed.
Example: Get VLAN configuration from all servers in a cluster
Request HeaderGET https://ucpmanagement.ucp.local/api/clusters/domain-c99/networksHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id":"host-622","UplinkConfigurations":[{"ConnectedEthernetSwitchPort":{"NativeVLanId":"13","PortId":"Ethernet110\/1\/1","SwitchId":"1","Vlans":"79-81,91,99"},"Name":"vmnic0","Vlans":"","WhatIfConfiguredSwitchPortVlans":"79-81,91,99"},{"ConnectedEthernetSwitchPort":{"NativeVLanId":"13","PortId":"Ethernet111\/1\/1","SwitchId":"2","Vlans":"79-81"},"Name":"vmnic1","Vlans":"","WhatIfConfiguredSwitchPortVlans":"79-81"}]},{
Chapter 2: UCP Director resources 65UCP Director API Reference
Cluster resources
"Id":"host-628","UplinkConfigurations":[{"ConnectedEthernetSwitchPort":{"NativeVLanId":"14","PortId":"Ethernet110\/1\/4","SwitchId":"1","Vlans":"79-81,91,99"},"Name":"vmnic0","Vlans":"","WhatIfConfiguredSwitchPortVlans":"79-81,91,99"},{"ConnectedEthernetSwitchPort":{"NativeVLanId":"14","PortId":"Ethernet111\/1\/4","SwitchId":"2","Vlans":"79-81"},"Name":"vmnic1","Vlans":"","WhatIfConfiguredSwitchPortVlans":"79-81"}]}]
Apply cluster network VLANs to Ethernet switches
This HTTP request uses the POST method on the /api/clusters/{clusterid}/networks/configurevlan URI, where {clusterid} specifies the ID of thecluster that is to have uplink VLAN configurations applied to the Ethernetswitch network paths used by each host in the cluster (including ports usedon both access and aggregate switches).
The UCP System Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Apply VLANs from servers in a cluster to the Ethernet switchesRequest HeaderPOST https://ucpmanagement.ucp.local/api/clusters/domain-c99/networks/configurevlan HTTP/1.1 Content-Type: application/json;charset=utf-8
66 Chapter 2: UCP Director resources
UCP Director API Reference
Cluster resources
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Configure Ethernet switch VLAN settingsbased on a cluster".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Converged switch resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List converged switches"on the next page
GET /api/convergedswitches UCP View
"Get converged switch"on page 116
GET/api/convergedswitches/{SWITCHID}
UCP View
"Add converged switch"on page 143
POST /api/convergedswitchesUCP NetworkAdministrator
"Remove convergedswitch" on page 144
DELETE/api/convergedswitches/{SWITCHID}
UCP NetworkAdministrator
"Get converged switchconnection information"on page 145
GET/api/convergedswitches/{SWITCHID}/connectioninformation
UCP View
"Modify converged switchconnection information"on page 147
PUT/api/convergedswitches/{SWITCHID}/connectioninformation
UCP NetworkAdministrator
"Get unmanaged ports ona converged switch" onpage 148
GET/api/convergedswitches/{SWITCHID}/unmanagedports
UCP View
"Set unmanaged ports ona converged switch" onpage 150
PUT/api/convergedswitches/{SWITCHID}/unmanagedports
UCP NetworkAdministrator
"Refresh convergedswitch inventory" onpage 151
POST /api/convergedswitches/refreshUCP NetworkAdministrator
Chapter 2: UCP Director resources 67UCP Director API Reference
Converged switch resources
List converged switches
This HTTP request uses the GET method on the /api/convergedswitchesURI.
The UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, a list of converged switches is returned. Theproperties for converged switches are described under the heading Getconverged switch.
Example: List all converged switches
Request HeaderGET https://ucpmanagement.ucp.local/api/convergedswitches HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "1","ResourceType": "ConvergedSwitch","GlobalResourceId": "inst.PODG-1234.conv.1.net.1","InstanceId": "PODG-1234","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.podg.local\/api\/convergedswitches\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.podg.local\/api\/convergedswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=self"},{"Rel": "jobs.subcomponent",
68 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.PODG-1234.conv.1.net.1","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Unknown","IndicatorType": "Health","Name": "Temperature","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Fan","IndicatorState": "Unknown","IndicatorType": "Health","Name": "Fan","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Power Supply","IndicatorState": "Unknown","IndicatorType": "Health",
Chapter 2: UCP Director resources 69UCP Director API Reference
Converged switch resources
"Name": "PowerSupply","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Ports","IndicatorState": "Unknown","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/14","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/24","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/23","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/22","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/21","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/20","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/11","inst.PODG-1234.conv.1.net.1.fcport.fc1\/30","inst.PODG-1234.conv.1.net.1.fcport.fc1\/31","inst.PODG-1234.conv.1.net.1.fcport.fc1\/32","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/15","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/12","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/17","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/12","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/11","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/19","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/18","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/16","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/13","inst.PODG-1234.conv.1.net.1.fcport.fc1\/25","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/8","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/9","inst.PODG-1234.conv.1.net.1.fcport.fc1\/26","inst.PODG-1234.conv.1.net.1.fcport.fc1\/27","inst.PODG-1234.conv.1.net.1.fcport.fc1\/28","inst.PODG-1234.conv.1.net.1.fcport.fc1\/29","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/15","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/3","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/4","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/5","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/6","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/7","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet2\/2","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/13","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/16",
70 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/9","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/8","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/3","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/2","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/1","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/7","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/6","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/5","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/4","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/10","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet2\/1","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/14","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/10"],"SubResourceType": "ConvergedSwitchEthernetPort"},{"DisplayName": "Ports","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": [
],"SubResourceType": "ConvergedSwitchFibreChannelPort"},{"DisplayName": "Ports","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": [
],"SubResourceType": "ConvergedSwitchFCoEPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 49,"NumOks": 0,"NumUnknowns": 51,"NumWarnings": 0,"ResourceState": "Unknown","ResourceType": "ConvergedSwitch","UpdatedDateTime": "4\/8\/2014 11:08:19 PM +00:00"},"FirmwareVersion": "6.0(2)N2(3)","Make": "Cisco","Model": "Nexus5548","Name": "R1-CS-5548-A-U42","SerialNumber": "FOC17012NGC","Status": "Active",
Chapter 2: UCP Director resources 71UCP Director API Reference
Converged switch resources
"Type": "Access","ConnectionInformation": {"Id": "0","ResourceType": "ConvergedSwitchConnectionInformation","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.cnn","InstanceId": "PODG-1234","IPAddress": "10.21.80.212","Username": "ucpadmin"},"EthernetPorts": [{"Id": "Ethernet1\/1","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/1","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/1","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "10.20.90.101","DeviceType": "External","PortAlias": null,"PortId": "mgmt0"}],"NativeVlanId": null,"PortChannelId": 10,"Vlans": "1,80-81,99,3001"},{"Id": "Ethernet1\/2","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/2","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/2","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "10.20.90.100","DeviceType": "External","PortAlias": null,"PortId": "mgmt0"}
72 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
],"NativeVlanId": null,"PortChannelId": 10,"Vlans": "1,80-81,99,3001"},{"Id": "Ethernet1\/3","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/3","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/3","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/4","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/4","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/4","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/5","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/5","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/5","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,
Chapter 2: UCP Director resources 73UCP Director API Reference
Converged switch resources
"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/6","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/6","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/6","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/7","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/7","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/7","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/8","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/8","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/8","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"
74 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
},{"Id": "Ethernet1\/9","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/9","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/9","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "3","DeviceType": "ConvergedSwitch","PortAlias": null,"PortId": "Ethernet1\/9"}],"NativeVlanId": null,"PortChannelId": 1,"Vlans": "1-3000,3002-4094"},{"Id": "Ethernet1\/10","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/10","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/10","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "3","DeviceType": "ConvergedSwitch","PortAlias": null,"PortId": "Ethernet1\/10"}],"NativeVlanId": null,"PortChannelId": 1,"Vlans": "1-3000,3002-4094"},{"Id": "Ethernet1\/13","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/13",
Chapter 2: UCP Director resources 75UCP Director API Reference
Converged switch resources
"InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/13","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80"},{"Id": "Ethernet1\/14","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/14","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/14","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80"},{"Id": "Ethernet1\/15","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/15","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/15","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "13-23,79-81"},{"Id": "Ethernet1\/16","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/16","InstanceId": "PODG-1234","MonitorState": null,
76 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/16","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "13-23,79-81"},{"Id": "Ethernet2\/3","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/3","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/3","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3001"},{"Id": "Ethernet2\/4","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/4","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/4","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3001"},{"Id": "Ethernet2\/5","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/5","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,
Chapter 2: UCP Director resources 77UCP Director API Reference
Converged switch resources
"PortId": "Ethernet2\/5","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/6","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/6","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/6","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/7","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/7","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/7","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/8","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/8","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/8","PortStatus": null,
78 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/9","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/9","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/9","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/10","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/10","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/10","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/11","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/11","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/11","PortStatus": null,"PortType": "Ethernet","DeviceId": "",
Chapter 2: UCP Director resources 79UCP Director API Reference
Converged switch resources
"EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/12","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/12","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/12","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/13","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/13","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/13","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/14","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/14","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/14","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,
80 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/15","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/15","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/15","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 50,"Vlans": "79-81"},{"Id": "Ethernet2\/16","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/16","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/16","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-81"}],"FCoEPorts": [{"Id": "Ethernet1\/11","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/11","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": true,"PortId": "Ethernet1\/11","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [
Chapter 2: UCP Director resources 81UCP Director API Reference
Converged switch resources
{"DeviceId": "mgmt-esx01.ucp.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic2"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80-81,3001","FCoEConnectedDevice": {"DeviceId": null,"DeviceType": "External","PortAlias": null,"PortId": "10:00:00:90:fa:2d:44:61"},"FabricId": null,"VfcId": "vfc11","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/12","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/12","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": true,"PortId": "Ethernet1\/12","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "mgmt-esx02.ucp.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic2"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80-81,3001","FCoEConnectedDevice": {"DeviceId": null,"DeviceType": "External","PortAlias": null,"PortId": "10:00:00:90:fa:2d:48:1f"},"FabricId": null,"VfcId": "vfc12",
82 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/17","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/17","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": true,"PortId": "Ethernet1\/17","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "0090.fa07.d7b7","DeviceType": "External","PortAlias": null,"PortId": "d05f.ce01.0202"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "bfbafbf8-369d-11e2-9bac-aa6d67137936","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:00"},"FabricId": null,"VfcId": "vfc17","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/18","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/18","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/18","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{
Chapter 2: UCP Director resources 83UCP Director API Reference
Converged switch resources
"DeviceId": "0e87acce-3672-11e2-841b-e571c94a2c22","DeviceType": "Server","PortAlias": null,"PortId": "vmnic2"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "0e87acce-3672-11e2-841b-e571c94a2c22","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:10"},"FabricId": null,"VfcId": "vfc18","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/19","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/19","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/19","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "R1-HI-CB500-1-B02.podg.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "e82b50cf-38e4-11e2-a2c8-9c66272ddbb1","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:40"},"FabricId": null,"VfcId": "vfc19","VfcStatus": null,
84 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"VsanId": 3001},{"Id": "Ethernet1\/20","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/20","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/20","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "R1-HI-CB500-1-B03.podg.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "840bb6ff-389e-11e2-87e7-c95b593f3200","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:50"},"FabricId": null,"VfcId": "vfc20","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/21","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/21","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/21","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "R1-HI-CB500-1-B04.podg.local",
Chapter 2: UCP Director resources 85UCP Director API Reference
Converged switch resources
"DeviceType": "External","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "20f36cc8-3684-11e2-af05-8973cafcd6d8","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:80"},"FabricId": null,"VfcId": "vfc21","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/22","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/22","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/22","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "b54e5465-3763-11e2-acbd-88a35d0fbb69","DeviceType": "Server","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "b54e5465-3763-11e2-acbd-88a35d0fbb69","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:90"},"FabricId": null,"VfcId": "vfc22","VfcStatus": null,"VsanId": 3001
86 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
},{"Id": "Ethernet1\/23","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/23","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/23","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "74dcfc13-367b-11e2-b44b-b2fc27719135","DeviceType": "Server","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "74dcfc13-367b-11e2-b44b-b2fc27719135","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:C0"},"FabricId": null,"VfcId": "vfc23","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/24","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/24","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/24","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "ddc11c10-3670-11e2-bec8-f0e685bb29df","DeviceType": "Server",
Chapter 2: UCP Director resources 87UCP Director API Reference
Converged switch resources
"PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "ddc11c10-3670-11e2-bec8-f0e685bb29df","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:D0"},"FabricId": null,"VfcId": "vfc24","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet2\/1","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet2\/1","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/1","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "bfbafbf8-369d-11e2-9bac-aa6d67137936","DeviceType": "Server","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3001","FCoEConnectedDevice": {"DeviceId": "bfbafbf8-369d-11e2-9bac-aa6d67137936","DeviceType": "Server","PortAlias": "2","PortId": "24:00:D0:5F:CE:01:02:04"},"FabricId": null,"VfcId": "vfc201","VfcStatus": null,"VsanId": 3001},{
88 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"Id": "Ethernet2\/2","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet2\/2","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/2","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "0090.fa07.d59f","DeviceType": "External","PortAlias": null,"PortId": "d05f.ce01.022a"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3001","FCoEConnectedDevice": {"DeviceId": "0e87acce-3672-11e2-841b-e571c94a2c22","DeviceType": "Server","PortAlias": "2","PortId": "24:00:D0:5F:CE:01:02:14"},"FabricId": null,"VfcId": "vfc202","VfcStatus": null,"VsanId": 3001}],"FibreChannelPorts": [{"Id": "fc1\/25","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/25","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/25","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": null,"VsanId": 3001},{"Id": "fc1\/26","ResourceType": "ConvergedSwitchFibreChannelPort",
Chapter 2: UCP Director resources 89UCP Director API Reference
Converged switch resources
"GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/26","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": true,"PortId": "fc1\/26","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": null,"VsanId": 3001},{"Id": "fc1\/27","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/27","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": true,"PortId": "fc1\/27","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL0-C","PortId": "50:06:0E:80:10:3A:F4:12"},"VsanId": 3001},{"Id": "fc1\/28","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/28","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/28","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-C","PortId": "50:06:0E:80:10:3A:F4:1A"},"VsanId": 3001},{
90 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"Id": "fc1\/29","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/29","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/29","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL0-E","PortId": "50:06:0E:80:10:3A:F4:14"},"VsanId": 3001},{"Id": "fc1\/30","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/30","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/30","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-E","PortId": "50:06:0E:80:10:3A:F4:1C"},"VsanId": 3001},{"Id": "fc1\/31","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/31","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/31","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]",
Chapter 2: UCP Director resources 91UCP Director API Reference
Converged switch resources
"DeviceType": "StorageSystem","PortAlias": "CTL0-G","PortId": "50:06:0E:80:10:3A:F4:16"},"VsanId": 3001},{"Id": "fc1\/32","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/32","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/32","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-G","PortId": "50:06:0E:80:10:3A:F4:1E"},"VsanId": 3001}]},{"Id": "3","ResourceType": "ConvergedSwitch","GlobalResourceId": "inst.PODG-1234.conv.1.net.3","InstanceId": "PODG-1234","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.podg.local\/api\/convergedswitches\/3"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.podg.local\/api\/convergedswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.3&relation=subcomponent"
92 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.3&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.PODG-1234.conv.1.net.3","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Unknown","IndicatorType": "Health","Name": "Temperature","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Fan","IndicatorState": "Unknown","IndicatorType": "Health","Name": "Fan","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Power Supply","IndicatorState": "Unknown","IndicatorType": "Health","Name": "PowerSupply","SubGlobalResourceIds": null,"SubResourceType": null
Chapter 2: UCP Director resources 93UCP Director API Reference
Converged switch resources
},{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Ports","IndicatorState": "Unknown","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.PODG-1234.conv.1.net.3.fcport.fc1\/32","inst.PODG-1234.conv.1.net.3.fcport.fc1\/30","inst.PODG-1234.conv.1.net.3.fcport.fc1\/31","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/10","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/12","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/14","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/16","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/8","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/9","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/3","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/6","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet2\/2","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/7","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/4","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/5","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/10","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/15","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/17","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/11","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/9","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/12","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/8","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/19","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/18","inst.PODG-1234.conv.1.net.3.fcport.fc1\/26","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/1","inst.PODG-1234.conv.1.net.3.fcport.fc1\/27","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/11","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/3","inst.PODG-1234.conv.1.net.3.fcport.fc1\/25","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/2","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/5","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/4","inst.PODG-1234.conv.1.net.3.fcport.fc1\/28","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/13","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/7","inst.PODG-1234.conv.1.net.3.fcport.fc1\/29","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/6",
94 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet2\/1","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/15","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/24","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/21","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/20","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/23","inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/22","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/14","inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/13","inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/16"],"SubResourceType": "ConvergedSwitchEthernetPort"},{"DisplayName": "Ports","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": [
],"SubResourceType": "ConvergedSwitchFibreChannelPort"},{"DisplayName": "Ports","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": [
],"SubResourceType": "ConvergedSwitchFCoEPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 49,"NumOks": 0,"NumUnknowns": 51,"NumWarnings": 0,"ResourceState": "Unknown","ResourceType": "ConvergedSwitch","UpdatedDateTime": "4\/8\/2014 11:08:19 PM +00:00"},"FirmwareVersion": "6.0(2)N2(3)","Make": "Cisco","Model": "Nexus5548","Name": "R1-CS-5548-B-U41","SerialNumber": "FOC170279DV","Status": "Active","Type": "Access","ConnectionInformation": {"Id": "0",
Chapter 2: UCP Director resources 95UCP Director API Reference
Converged switch resources
"ResourceType": "ConvergedSwitchConnectionInformation","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.cnn","InstanceId": "PODG-1234","IPAddress": "10.21.80.213","Username": "ucpadmin"},"EthernetPorts": [{"Id": "Ethernet1\/1","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/1","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/1","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "10.20.90.100","DeviceType": "External","PortAlias": null,"PortId": "mgmt0"}],"NativeVlanId": null,"PortChannelId": 10,"Vlans": "1,22-23,80-81,99,3002"},{"Id": "Ethernet1\/2","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/2","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/2","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "10.20.90.101","DeviceType": "External","PortAlias": null,"PortId": "mgmt0"}],"NativeVlanId": null,"PortChannelId": 10,
96 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"Vlans": "1,22-23,80-81,99,3002"},{"Id": "Ethernet1\/3","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/3","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/3","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/4","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/4","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/4","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/5","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/5","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/5","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},
Chapter 2: UCP Director resources 97UCP Director API Reference
Converged switch resources
{"Id": "Ethernet1\/6","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/6","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/6","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/7","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/7","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/7","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/8","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/8","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/8","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/9",
98 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/9","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/9","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "1","DeviceType": "ConvergedSwitch","PortAlias": null,"PortId": "Ethernet1\/9"}],"NativeVlanId": null,"PortChannelId": 1,"Vlans": "1-3001,3003-4094"},{"Id": "Ethernet1\/10","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/10","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/10","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "1","DeviceType": "ConvergedSwitch","PortAlias": null,"PortId": "Ethernet1\/10"}],"NativeVlanId": null,"PortChannelId": 1,"Vlans": "1-3001,3003-4094"},{"Id": "Ethernet1\/13","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/13","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,
Chapter 2: UCP Director resources 99UCP Director API Reference
Converged switch resources
"IsUnmanaged": false,"PortId": "Ethernet1\/13","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80"},{"Id": "Ethernet1\/14","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/14","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/14","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80"},{"Id": "Ethernet1\/15","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/15","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/15","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "13-234"},{"Id": "Ethernet1\/16","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet1\/16","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/16",
100 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "13-23,79-81"},{"Id": "Ethernet2\/3","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/3","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/3","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3002"},{"Id": "Ethernet2\/4","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/4","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/4","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3002"},{"Id": "Ethernet2\/5","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/5","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/5","PortStatus": null,"PortType": "Ethernet",
Chapter 2: UCP Director resources 101UCP Director API Reference
Converged switch resources
"DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/6","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/6","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/6","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/7","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/7","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/7","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/8","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/8","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/8","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,
102 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/9","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/9","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/9","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/10","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/10","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/10","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/11","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/11","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/11","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,
Chapter 2: UCP Director resources 103UCP Director API Reference
Converged switch resources
"Vlans": "1"},{"Id": "Ethernet2\/12","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/12","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/12","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/13","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/13","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/13","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/14","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/14","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/14","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},
104 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
{"Id": "Ethernet2\/15","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/15","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/15","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/16","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.ethport.Ethernet2\/16","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/16","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"}],"FCoEPorts": [{"Id": "Ethernet1\/11","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/11","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/11","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "mgmt-esx01.ucp.local","DeviceType": "External",
Chapter 2: UCP Director resources 105UCP Director API Reference
Converged switch resources
"PortAlias": null,"PortId": "vmnic3"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80-81,3002","FCoEConnectedDevice": {"DeviceId": null,"DeviceType": "External","PortAlias": null,"PortId": "10:00:00:90:fa:2d:44:65"},"FabricId": null,"VfcId": "vfc11","VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet1\/12","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/12","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/12","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "mgmt-esx02.ucp.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic3"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80-81,3002","FCoEConnectedDevice": {"DeviceId": null,"DeviceType": "External","PortAlias": null,"PortId": "10:00:00:90:fa:2d:48:23"},"FabricId": null,"VfcId": "vfc12","VfcStatus": null,"VsanId": 3002},
106 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
{"Id": "Ethernet1\/17","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/17","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/17","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "0090.fa07.d7bb","DeviceType": "External","PortAlias": null,"PortId": "d05f.ce01.0203"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3002","FCoEConnectedDevice": {"DeviceId": "bfbafbf8-369d-11e2-9bac-aa6d67137936","DeviceType": "Server","PortAlias": "1","PortId": "24:00:D0:5F:CE:01:02:02"},"FabricId": null,"VfcId": "vfc17","VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet1\/18","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/18","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/18","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "0090.fa07.d59b","DeviceType": "External","PortAlias": null,
Chapter 2: UCP Director resources 107UCP Director API Reference
Converged switch resources
"PortId": "d05f.ce01.0223"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3002","FCoEConnectedDevice": {"DeviceId": "0e87acce-3672-11e2-841b-e571c94a2c22","DeviceType": "Server","PortAlias": "1","PortId": "24:00:D0:5F:CE:01:02:12"},"FabricId": null,"VfcId": "vfc18","VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet1\/19","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/19","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/19","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "e82b50cf-38e4-11e2-a2c8-9c66272ddbb1","DeviceType": "Server","PortAlias": null,"PortId": "vmnic1"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3002","FCoEConnectedDevice": {"DeviceId": "e82b50cf-38e4-11e2-a2c8-9c66272ddbb1","DeviceType": "Server","PortAlias": "1","PortId": "24:00:D0:5F:CE:01:02:42"},"FabricId": null,"VfcId": "vfc19","VfcStatus": null,"VsanId": 3002},{
108 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"Id": "Ethernet1\/20","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/20","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/20","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "840bb6ff-389e-11e2-87e7-c95b593f3200","DeviceType": "Server","PortAlias": null,"PortId": "vmnic1"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3002","FCoEConnectedDevice": {"DeviceId": "840bb6ff-389e-11e2-87e7-c95b593f3200","DeviceType": "Server","PortAlias": "1","PortId": "24:00:D0:5F:CE:01:02:52"},"FabricId": null,"VfcId": "vfc20","VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet1\/21","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/21","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/21","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "20f36cc8-3684-11e2-af05-8973cafcd6d8","DeviceType": "Server","PortAlias": null,"PortId": "vmnic1"
Chapter 2: UCP Director resources 109UCP Director API Reference
Converged switch resources
}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3002","FCoEConnectedDevice": {"DeviceId": "20f36cc8-3684-11e2-af05-8973cafcd6d8","DeviceType": "Server","PortAlias": "1","PortId": "24:00:D0:5F:CE:01:02:82"},"FabricId": null,"VfcId": "vfc21","VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet1\/22","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/22","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/22","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3002","FCoEConnectedDevice": null,"FabricId": null,"VfcId": "vfc22","VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet1\/23","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/23","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/23","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [
110 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
{"DeviceId": "R1-HI-CB500-1-B06.podg.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic1"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3002","FCoEConnectedDevice": {"DeviceId": "74dcfc13-367b-11e2-b44b-b2fc27719135","DeviceType": "Server","PortAlias": "1","PortId": "24:00:D0:5F:CE:01:02:C2"},"FabricId": null,"VfcId": "vfc23","VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet1\/24","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet1\/24","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/24","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "R1-HI-CB500-1-B07.podg.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic1"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3002","FCoEConnectedDevice": {"DeviceId": "ddc11c10-3670-11e2-bec8-f0e685bb29df","DeviceType": "Server","PortAlias": "1","PortId": "24:00:D0:5F:CE:01:02:D2"},"FabricId": null,"VfcId": "vfc24",
Chapter 2: UCP Director resources 111UCP Director API Reference
Converged switch resources
"VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet2\/1","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet2\/1","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/1","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "bfbafbf8-369d-11e2-9bac-aa6d67137936","DeviceType": "Server","PortAlias": null,"PortId": "vmnic1"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3002","FCoEConnectedDevice": {"DeviceId": "bfbafbf8-369d-11e2-9bac-aa6d67137936","DeviceType": "Server","PortAlias": "3","PortId": "24:00:D0:5F:CE:01:02:06"},"FabricId": null,"VfcId": "vfc201","VfcStatus": null,"VsanId": 3002},{"Id": "Ethernet2\/2","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcoeport.Ethernet2\/2","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/2","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "0090.fa07.d5a3","DeviceType": "External",
112 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"PortAlias": null,"PortId": "d05f.ce01.022b"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3002","FCoEConnectedDevice": {"DeviceId": "0e87acce-3672-11e2-841b-e571c94a2c22","DeviceType": "Server","PortAlias": "3","PortId": "24:00:D0:5F:CE:01:02:16"},"FabricId": null,"VfcId": "vfc202","VfcStatus": null,"VsanId": 3002}],"FibreChannelPorts": [{"Id": "fc1\/25","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcport.fc1\/25","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/25","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": null,"VsanId": 3002},{"Id": "fc1\/26","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcport.fc1\/26","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/26","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": null,"VsanId": 3002},{"Id": "fc1\/27","ResourceType": "ConvergedSwitchFibreChannelPort",
Chapter 2: UCP Director resources 113UCP Director API Reference
Converged switch resources
"GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcport.fc1\/27","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/27","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL0-D","PortId": "50:06:0E:80:10:3A:F4:13"},"VsanId": 3002},{"Id": "fc1\/28","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcport.fc1\/28","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/28","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-D","PortId": "50:06:0E:80:10:3A:F4:1B"},"VsanId": 3002},{"Id": "fc1\/29","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcport.fc1\/29","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/29","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL0-F",
114 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"PortId": "50:06:0E:80:10:3A:F4:15"},"VsanId": 3002},{"Id": "fc1\/30","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcport.fc1\/30","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/30","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-F","PortId": "50:06:0E:80:10:3A:F4:1D"},"VsanId": 3002},{"Id": "fc1\/31","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcport.fc1\/31","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/31","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL0-H","PortId": "50:06:0E:80:10:3A:F4:17"},"VsanId": 3002},{"Id": "fc1\/32","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.3.fcport.fc1\/32","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/32",
Chapter 2: UCP Director resources 115UCP Director API Reference
Converged switch resources
"PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-H","PortId": "50:06:0E:80:10:3A:F4:1F"},"VsanId": 3002}]}]
Get converged switch
This HTTP request uses the GET method on the /api/convergedswitches/{SWITCHID} URI, where {SWITCHID} specifies the ID of the convergedswitch that is to be returned.
The UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following chart.
Name Type Notes
(Common properties) See Common properties
MonitorState CollectionCollection of monitor state information aboutthe switch.
GlobalResourceId String Global resource Id of the switch.
MonitorIndicators CollectionCollection of monitor indicators for theswitch.
DisplayName String Display name for the monitor indicator.
IndicatorType String Type of indicator.
Name String Name of the indicator.
SubGlobalResourceIds String
Global Ids of subresources. When themonitor indicator is “Ports”, this section willbe populated with a comma delimited list ofEthernet switch port global Ids.
116 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
Name Type Notes
SubResourceType String
Type of the sub resource, if any. When themonitor indicator is “Ports”, theSubResourceType will be“EthernetSwitchPort”.
MonitorMode StringThe mode of reporting SNMP traps. Monitor,Report or Off.
NumErrors Int32Number of errors totaled fromSubGlobalResourceIds.
NumNotApplicables Int32Number of NAmessages totaled fromSubGlobalResourceIds.
NumOks Int32Number of OKmessages totaled fromSubGlobalResourceIds.
NumUnknowns Int32Number of Unknown messages totaled fromSubGlobalResourceIds.
NumWarnings Int32Number of Warnings totaled fromSubGlobalResourceIds.
ResourceState String Monitor state of the Ethernet switch.
ResourceType StringResource type. Always “EthernetSwitch” forEthernet switches.
UpdatedDateTime DateTimeDate and time of the last Monitor modeaggregation.
AvailableFirmwareVersion StringFirmware which UCP has available to updatethe Ethernet switches.
ConnectionInformation CollectionConnection information that UCP uses tomanage switches.
Id StringThe identifier forEthernetSwitchConnectionInformationobject.
ResourceType StringAlways“EthernetSwitchConnectionInformation”.
GlobalResourceId StringGlobally unique Id for this collection ofconnection information.
InstanceId StringId of the UCP instance to which the switchand its connection information belongs.
IPAddress String The management IP address for the switch.
Username StringThe username used by UCP tomanage theswitch.
Make String The Ethernet switch’s manufacturer.
Chapter 2: UCP Director resources 117UCP Director API Reference
Converged switch resources
Name Type Notes
Model String The Ethernet switch’s model number.
Name String Friendly name of the Ethernet switch.
OSVersion String Version of the OS on the Ethernet switch.
Ports CollectionCollection of information about each port onthe switch.
(Common properties)All ports are listed, each having theproperties described under the headingCommon properties.
MonitorState CollectionReports information about the device (hostor switch) connected on the port. Null whennot connected to a host or a switch.
MonitorIndicators Collection
A collection of monitor indicators is listed foreach port. Monitor indicators for ports are thesame as for the switch. See the upper sectionof this chart.
ConnectedDevice CollectionCollection of information about the deviceconnected to this Ethernet port.
DeviceId String Identifies the connected device.
IsConnected BooleanWhether or not the port is connected toanything. If False, the port has nothingconnected.
IsUnmanaged Boolean
Identifies if UCP does not manage it. Whenthe port is not managed, True (an option forports on aggregate switches). Otherwise,False (managed).
NativeVlanId String Native VLAN ID configured for this port.
PortChannelId Int32Identifies the Port Channel the port is a partof.
PortId String
Identifies the port of the connected device.When connected to a host, this is the nameof the host’s uplink to this port on the switch.When connected to another switch, this isthe port on the other switch.
Vlans String
The comma delimited list of VLANsconfigured on the port. Each element iseither a number or a range of numbersspecified with a dash. For example: “101-105, 500”.
118 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
Name Type Notes
DeviceType String
Identifies the type of the connected device.Values:• EthernetSwitch• Server• Unknown
PortId String Identifies the port.
SerialNumber String The serial number of the switch.
Status String
Identifies the switch status. Values:• Initializing• Active• Unreachable• Unsupported
Type StringIdentifies the type of the switch. Values:• Access• Aggregate
Example: Get a converged switch
Request HeaderGET https://ucpmanagement.ucp.local/api/convergedswitches/1 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "1","ResourceType": "ConvergedSwitch","GlobalResourceId": "inst.PODG-1234.conv.1.net.1","InstanceId": "PODG-1234","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.podg.local\/api\/convergedswitches\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.podg.local\/api\/convergedswitches"},{"Rel": "jobs.self",
Chapter 2: UCP Director resources 119UCP Director API Reference
Converged switch resources
"Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitch&targetId=inst.PODG-1234.conv.1.net.1&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.PODG-1234.conv.1.net.1","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Unknown","IndicatorType": "Health","Name": "Temperature","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Fan","IndicatorState": "Unknown","IndicatorType": "Health","Name": "Fan","SubGlobalResourceIds": null,
120 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"SubResourceType": null},{"DisplayName": "Power Supply","IndicatorState": "Unknown","IndicatorType": "Health","Name": "PowerSupply","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Ports","IndicatorState": "Unknown","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/14","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/24","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/23","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/22","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/21","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/20","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/11","inst.PODG-1234.conv.1.net.1.fcport.fc1\/30","inst.PODG-1234.conv.1.net.1.fcport.fc1\/31","inst.PODG-1234.conv.1.net.1.fcport.fc1\/32","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/15","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/12","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/17","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/12","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/11","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/19","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/18","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/16","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/13","inst.PODG-1234.conv.1.net.1.fcport.fc1\/25","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/8","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/9","inst.PODG-1234.conv.1.net.1.fcport.fc1\/26","inst.PODG-1234.conv.1.net.1.fcport.fc1\/27","inst.PODG-1234.conv.1.net.1.fcport.fc1\/28","inst.PODG-1234.conv.1.net.1.fcport.fc1\/29","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/15","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/3","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/4",
Chapter 2: UCP Director resources 121UCP Director API Reference
Converged switch resources
"inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/5","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/6","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/7","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet2\/2","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/13","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/16","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/9","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/8","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/3","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/2","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/1","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/7","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/6","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/5","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/4","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/10","inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet2\/1","inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/14","inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/10"],"SubResourceType": "ConvergedSwitchEthernetPort"},{"DisplayName": "Ports","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": [
],"SubResourceType": "ConvergedSwitchFibreChannelPort"},{"DisplayName": "Ports","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": [
],"SubResourceType": "ConvergedSwitchFCoEPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 49,"NumOks": 0,"NumUnknowns": 51,"NumWarnings": 0,"ResourceState": "Unknown","ResourceType": "ConvergedSwitch","UpdatedDateTime": "4\/9\/2014 12:53:15 AM +00:00"},
122 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"FirmwareVersion": "6.0(2)N2(3)","Make": "Cisco","Model": "Nexus5548","Name": "R1-CS-5548-A-U42","SerialNumber": "FOC17012NGC","Status": "Active","Type": "Access","ConnectionInformation": {"Id": "0","ResourceType": "ConvergedSwitchConnectionInformation","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.cnn","InstanceId": "PODG-1234","IPAddress": "10.21.80.212","Username": "ucpadmin"},"EthernetPorts": [{"Id": "Ethernet1\/1","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/1","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/1","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "10.20.90.101","DeviceType": "External","PortAlias": null,"PortId": "mgmt0"}],"NativeVlanId": null,"PortChannelId": 10,"Vlans": "1,80-81,99,3001"},{"Id": "Ethernet1\/2","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/2","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/2","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [
Chapter 2: UCP Director resources 123UCP Director API Reference
Converged switch resources
{"DeviceId": "10.20.90.100","DeviceType": "External","PortAlias": null,"PortId": "mgmt0"}],"NativeVlanId": null,"PortChannelId": 10,"Vlans": "1,80-81,99,3001"},{"Id": "Ethernet1\/3","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/3","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/3","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/4","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/4","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/4","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/5","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/5","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,
124 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"PortId": "Ethernet1\/5","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/6","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/6","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/6","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/7","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/7","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/7","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/8","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/8","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/8","PortStatus": null,
Chapter 2: UCP Director resources 125UCP Director API Reference
Converged switch resources
"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet1\/9","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/9","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/9","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "3","DeviceType": "ConvergedSwitch","PortAlias": null,"PortId": "Ethernet1\/9"}],"NativeVlanId": null,"PortChannelId": 1,"Vlans": "1-3000,3002-4094"},{"Id": "Ethernet1\/10","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/10","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/10","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "3","DeviceType": "ConvergedSwitch","PortAlias": null,"PortId": "Ethernet1\/10"}],"NativeVlanId": null,"PortChannelId": 1,
126 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"Vlans": "1-3000,3002-4094"},{"Id": "Ethernet1\/13","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/13","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/13","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80"},{"Id": "Ethernet1\/14","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/14","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/14","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80"},{"Id": "Ethernet1\/15","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/15","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/15","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "13-23,79-81"},
Chapter 2: UCP Director resources 127UCP Director API Reference
Converged switch resources
{"Id": "Ethernet1\/16","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet1\/16","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/16","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "13-23,79-81"},{"Id": "Ethernet2\/3","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/3","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/3","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3001"},{"Id": "Ethernet2\/4","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/4","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/4","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3001"},{"Id": "Ethernet2\/5",
128 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/5","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/5","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/6","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/6","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/6","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/7","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/7","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/7","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/8","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/8",
Chapter 2: UCP Director resources 129UCP Director API Reference
Converged switch resources
"InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/8","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/9","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/9","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/9","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/10","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/10","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/10","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/11","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/11","InstanceId": "PODG-1234","MonitorState": null,
130 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/11","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/12","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/12","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/12","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/13","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/13","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/13","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/14","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/14","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,
Chapter 2: UCP Director resources 131UCP Director API Reference
Converged switch resources
"PortId": "Ethernet2\/14","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/15","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/15","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/15","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 0,"Vlans": "1"},{"Id": "Ethernet2\/16","ResourceType": "ConvergedSwitchEthernetPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.ethport.Ethernet2\/16","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/16","PortStatus": null,"PortType": "Ethernet","DeviceId": "","EthernetConnectedDevices": null,"NativeVlanId": null,"PortChannelId": 50,"Vlans": "79-81"}],"FCoEPorts": [{"Id": "Ethernet1\/11","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/11","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,
132 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"IsUnmanaged": true,"PortId": "Ethernet1\/11","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "mgmt-esx01.ucp.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic2"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80-81,3001","FCoEConnectedDevice": {"DeviceId": null,"DeviceType": "External","PortAlias": null,"PortId": "10:00:00:90:fa:2d:44:61"},"FabricId": null,"VfcId": "vfc11","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/12","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/12","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": true,"PortId": "Ethernet1\/12","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "mgmt-esx02.ucp.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic2"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80-81,3001","FCoEConnectedDevice": {"DeviceId": null,
Chapter 2: UCP Director resources 133UCP Director API Reference
Converged switch resources
"DeviceType": "External","PortAlias": null,"PortId": "10:00:00:90:fa:2d:48:1f"},"FabricId": null,"VfcId": "vfc12","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/17","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/17","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": true,"PortId": "Ethernet1\/17","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "0090.fa07.d7b7","DeviceType": "External","PortAlias": null,"PortId": "d05f.ce01.0202"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": null,"FabricId": null,"VfcId": "vfc17","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/18","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/18","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/18","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [
134 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
{"DeviceId": "0e87acce-3672-11e2-841b-e571c94a2c22","DeviceType": "Server","PortAlias": null,"PortId": "vmnic2"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "0e87acce-3672-11e2-841b-e571c94a2c22","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:10"},"FabricId": null,"VfcId": "vfc18","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/19","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/19","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/19","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "R1-HI-CB500-1-B02.podg.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "e82b50cf-38e4-11e2-a2c8-9c66272ddbb1","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:40"},"FabricId": null,"VfcId": "vfc19",
Chapter 2: UCP Director resources 135UCP Director API Reference
Converged switch resources
"VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/20","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/20","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/20","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "R1-HI-CB500-1-B03.podg.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "840bb6ff-389e-11e2-87e7-c95b593f3200","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:50"},"FabricId": null,"VfcId": "vfc20","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/21","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/21","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/21","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{
136 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"DeviceId": "R1-HI-CB500-1-B04.podg.local","DeviceType": "External","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "20f36cc8-3684-11e2-af05-8973cafcd6d8","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:80"},"FabricId": null,"VfcId": "vfc21","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/22","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/22","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/22","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "b54e5465-3763-11e2-acbd-88a35d0fbb69","DeviceType": "Server","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "b54e5465-3763-11e2-acbd-88a35d0fbb69","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:90"},"FabricId": null,"VfcId": "vfc22","VfcStatus": null,
Chapter 2: UCP Director resources 137UCP Director API Reference
Converged switch resources
"VsanId": 3001},{"Id": "Ethernet1\/23","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/23","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/23","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "74dcfc13-367b-11e2-b44b-b2fc27719135","DeviceType": "Server","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "74dcfc13-367b-11e2-b44b-b2fc27719135","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:C0"},"FabricId": null,"VfcId": "vfc23","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet1\/24","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet1\/24","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet1\/24","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "ddc11c10-3670-11e2-bec8-f0e685bb29df",
138 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"DeviceType": "Server","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "80,3001","FCoEConnectedDevice": {"DeviceId": "ddc11c10-3670-11e2-bec8-f0e685bb29df","DeviceType": "Server","PortAlias": "0","PortId": "24:00:D0:5F:CE:01:02:D0"},"FabricId": null,"VfcId": "vfc24","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet2\/1","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet2\/1","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/1","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "bfbafbf8-369d-11e2-9bac-aa6d67137936","DeviceType": "Server","PortAlias": null,"PortId": "vmnic0"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3001","FCoEConnectedDevice": null,"FabricId": null,"VfcId": "vfc201","VfcStatus": null,"VsanId": 3001},{"Id": "Ethernet2\/2","ResourceType": "ConvergedSwitchFCoEPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcoeport.Ethernet2\/2","InstanceId": "PODG-1234",
Chapter 2: UCP Director resources 139UCP Director API Reference
Converged switch resources
"MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "Ethernet2\/2","PortStatus": null,"PortType": "FCoE","DeviceId": "","EthernetConnectedDevices": [{"DeviceId": "0090.fa07.d59f","DeviceType": "External","PortAlias": null,"PortId": "d05f.ce01.022a"}],"NativeVlanId": null,"PortChannelId": 0,"Vlans": "79-82,3001","FCoEConnectedDevice": {"DeviceId": "0e87acce-3672-11e2-841b-e571c94a2c22","DeviceType": "Server","PortAlias": "2","PortId": "24:00:D0:5F:CE:01:02:14"},"FabricId": null,"VfcId": "vfc202","VfcStatus": null,"VsanId": 3001}],"FibreChannelPorts": [{"Id": "fc1\/25","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/25","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/25","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": null,"VsanId": 3001},{"Id": "fc1\/26","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/26","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,
140 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"IsUnmanaged": true,"PortId": "fc1\/26","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": null,"VsanId": 3001},{"Id": "fc1\/27","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/27","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": true,"PortId": "fc1\/27","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL0-C","PortId": "50:06:0E:80:10:3A:F4:12"},"VsanId": 3001},{"Id": "fc1\/28","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/28","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/28","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-C","PortId": "50:06:0E:80:10:3A:F4:1A"},"VsanId": 3001},{"Id": "fc1\/29","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/29","InstanceId": "PODG-1234",
Chapter 2: UCP Director resources 141UCP Director API Reference
Converged switch resources
"MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/29","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL0-E","PortId": "50:06:0E:80:10:3A:F4:14"},"VsanId": 3001},{"Id": "fc1\/30","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/30","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/30","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-E","PortId": "50:06:0E:80:10:3A:F4:1C"},"VsanId": 3001},{"Id": "fc1\/31","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/31","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/31","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL0-G","PortId": "50:06:0E:80:10:3A:F4:16"},
142 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"VsanId": 3001},{"Id": "fc1\/32","ResourceType": "ConvergedSwitchFibreChannelPort","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.fcport.fc1\/32","InstanceId": "PODG-1234","MonitorState": null,"IsEnabled": false,"IsUnmanaged": false,"PortId": "fc1\/32","PortStatus": null,"PortType": "FibreChannel","FabricId": null,"FcConnectedDevice": {"DeviceId": "[email protected]","DeviceType": "StorageSystem","PortAlias": "CTL1-G","PortId": "50:06:0E:80:10:3A:F4:1E"},"VsanId": 3001}]}
Add converged switch
This HTTP request uses the POST method on the /api/convergedswitchesURI.
The process of adding a converged switch to inventory includes:
• Verifying that the make, model, and OS version are supported
• Ensuring that all ports are enabled.
• Ensuring that link layer discovery protocol (LLDP/CDP) is enabled.
• When monitoring is enabled, the switch is also configured to reportSNMP traps to UCP.
When a converged switch is successfully added to inventory, its state is setto Initializing.
The UCP Network Administrator privilege is required.
Request body
This request body consists of the properties in the following table.
Chapter 2: UCP Director resources 143UCP Director API Reference
Converged switch resources
Name Type Notes
IPAddress StringSpecifies the management IP address ofthe Ethernet switch that is to be added toinventory
Username String
Specifies the username to be used tomanage the Ethernet switch. May containup to 40 letters, digits, underscores orperiods.
Password String
Specifies the password to be used tomanage the Ethernet switch. Must be atleast 8 characters long and at most 40characters long.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Add a converged switch to inventoryRequest HeaderPOST https://ucpmanagement.ucp.local/api/convergedswitches HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body[{"IPAddress": "10.21.57.215","Username": "ucpadmin","Password": "Kum0@pur@1nS"}]
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Add converged switch to inventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Remove converged switch
This HTTP request uses the DELETE method on the /api/convergedswitches/{SWITCHID} URI, where {SWITCHID} specifies the ID of the convergedswitch that is to be removed from inventory.
The UCP Network Administrator privilege is required.
144 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Remove a converged switch from inventory
Request HeaderDELETE https://ucpmanagement.ucp.local/api/convergedswitches/4 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Remove converged switch frominventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get converged switch connection information
This HTTP request uses the GET method on the api/convergedswitches/{SWITCHID}/connectioninformation URI. The connection information forthe specified switch is returned.
The UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following chart.
Name Type Notes
(Common properties) See Common properties
IPAddress String The management IP address of the switch.
Username String The username used tomanage the switch.
Chapter 2: UCP Director resources 145UCP Director API Reference
Converged switch resources
Example: Get connection information for a converged switch
Request HeaderGEThttps://ucpmanagement.ucp.local/api/convergedswitches/4/connectioninformation HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "0","ResourceType": "ConvergedSwitchConnectionInformation","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.cnn","InstanceId": "PODG-1234","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.podg.local\/api\/convergedswitches\/1\/connectioninformation"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitchConnectionInformation&targetId=inst.PODG-1234.conv.1.net.1.cnn&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitchConnectionInformation&targetId=inst.PODG-1234.conv.1.net.1.cnn&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitchConnectionInformation&targetId=inst.PODG-1234.conv.1.net.1.cnn&relation=self%7Csubcomponent"},{"Rel": "events.self",
146 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
"Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitchConnectionInformation&targetId=inst.PODG-1234.conv.1.net.1.cnn&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitchConnectionInformation&targetId=inst.PODG-1234.conv.1.net.1.cnn&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitchConnectionInformation&targetId=inst.PODG-1234.conv.1.net.1.cnn&relation=self%7Csubcomponent"}],"IPAddress": "10.21.80.212","Username": "ucpadmin"}
Modify converged switch connection information
This HTTP request uses the PUT method on the /api/convergedswitches/{SWITCHID}/connectioninformation URI, where {SWITCHID} specifies theID of the converged switch with the connection information that is to bemodified.
The UCP Network Administrator privilege is required.
This request body consists of the properties in the following chart.
Name Type Notes
SwitchIPAddress StringSpecifies the new management IP addressof the converged switch.
Username String
Specifies the new username that is to beused tomanage the converged switch. Maycontain letters, digits, underscores orperiods. The maximum length allowed is40.
Password String
Specifies the new password that is to beused tomanage the converged switch.Must be at least 8 characters long and atmost 40 characters long.
Chapter 2: UCP Director resources 147UCP Director API Reference
Converged switch resources
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Modify the credentials used to manage a converged switch
Request HeaderPUThttps://ucpmanagement.ucp.local/api/convergedswitches/1/connectioninformation HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"SwitchIpAddress": "10.21.57.215","Username": "ucpadmin","Password": "Kum0@pur@1nS"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update converged switch connectioninformation".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get unmanaged ports on a converged switch
This HTTP request uses the GET method on the /api/convergedswitches/{SWITCHID}/unmanagedports URI. The list of unmanaged ports for thespecified switch is returned. When a port is unmanaged, it is unaffectedwhen UCP configures converged switch ports in either of the two followingscenarios: resetting VLAN IDs to all ports or configuring VLANs from hosts.This is important for certain blades participating on different networks fromthe ESXi blades. For example, bare-metal Windows or Linux deploymentsmight use a different set of VLAN IDs than the ESXi blades.
The UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
148 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
Name Type Notes
(Common properties) See Common properties
UnmanagedPorts StringList of ports that will not be managed byUCP Director
Example: Get a converged switch’s unmanaged ports
Request HeaderGEThttps://ucpmanagement.ucp.local/api/convergedswitches/1/unmanagedportsHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "0","ResourceType": "ConvergedSwitchUnmanagedPorts","GlobalResourceId": "inst.PODG-1234.conv.1.net.1.unmngdp","InstanceId": "PODG-1234","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.podg.local\/api\/convergedswitches\/1\/unmanagedports"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitchUnmanagedPorts&targetId=inst.PODG-1234.conv.1.net.1.unmngdp&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitchUnmanagedPorts&targetId=inst.PODG-1234.conv.1.net.1.unmngdp&relation=subcomponent"},{"Rel": "jobs.all",
Chapter 2: UCP Director resources 149UCP Director API Reference
Converged switch resources
"Href":"https:\/\/ucpmanagement.podg.local\/api\/jobs?targetType=ConvergedSwitchUnmanagedPorts&targetId=inst.PODG-1234.conv.1.net.1.unmngdp&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitchUnmanagedPorts&targetId=inst.PODG-1234.conv.1.net.1.unmngdp&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitchUnmanagedPorts&targetId=inst.PODG-1234.conv.1.net.1.unmngdp&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podg.local\/api\/events?targetType=ConvergedSwitchUnmanagedPorts&targetId=inst.PODG-1234.conv.1.net.1.unmngdp&relation=self%7Csubcomponent"}],"UnmanagedPorts": ["Ethernet1\/11","Ethernet1\/12","Ethernet1\/17","fc1\/26","fc1\/27"]}
Set unmanaged ports on a converged switch
This HTTP request uses the PUT method on the /api/convergedswitches/{SWITCHID}/unmanagedports URI, where {SWITCHID} specifies the ID ofthe converged switch that is to have ports designated as unmanaged.
The UCP Network Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
UnmanagedPorts StringA comma separated list of ports that willnot be managed by UCP Director.
150 Chapter 2: UCP Director resources
UCP Director API Reference
Converged switch resources
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Specify unmanaged ports for an converged switch
Request HeaderPUThttps://ucpmanagement.ucp.local/api/convergedswitches/1/unmanagedportsHTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"UnmanagedPorts": ["TenGigabitEthernet 0/1","TenGigabitEthernet 0/2","TenGigabitEthernet 0/12","TenGigabitEthernet 0/16","fc 1/16",]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Save converged switch unmanagedports".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Refresh converged switch inventory
This HTTP request uses the POST method on the/api/convergedswitches/refresh URI.
This request accomplishes the following for every converged switch ininventory:
• Discovers connectivity between switch ports and devices.
• Ensures LLDP/CPD is enabled.
• Validates and configures SNMP settings.
• Configures port channels or VPC in case of Cisco model.
• Configures Spanning Tree protocol.
Chapter 2: UCP Director resources 151UCP Director API Reference
Converged switch resources
• Detects and reports unreachable and unsupported switches.
• Detects and reports host VLANs that are missing from access switchports.
The UCP Network Administrator privilege is required.
Request body
The body for this request must be empty.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Refresh converged switch inventory
Request HeaderPOST https://ucpmanagement.ucp.local/api/convergedswitches/refreshHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Refresh converged switch inventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Configuration resourcesThis API is used to get or update a variety of configuration settings. Anexample would be the IP address of the UCPManagement VM, or thepassword for AMQP service.
152 Chapter 2: UCP Director resources
UCP Director API Reference
Configuration resources
The POST method on this API accepts partial payloads.
Request Method URIvCenterPrivilege
"Set UCP configuration"below
POST /api/configuration/ucpconfigurationUCP SystemAdmin
"Get UCP Configuration"on the next page
GET /api/configuration/ucpconfiguration UCP View
Set UCP configuration
This HTTP request uses the POST method on the/api/configuration/ucpconfiguration API. It sets a variety of UCP settingsand accepts partial updates.
This API requires UCP System Administrator privilege.
The following properties and values are accepted in the request payload.
Name Type Notes
AmqpPassword StringThe AMQP password. Must be submittedalongwith the AmqpUsername.
AmqpUsername StringThe AMQP username. AMQP is protocolused for queuing UCP jobs.
RaidcomUsername StringUsername for the account that hasadministrative access to the UCP resourcegroup in the G1000 storage array.
RaidcomPassword StringPassword for the account that hasadministrative access to the UCP resourcegroup in the G1000 storage array.
ScpServerIpAddress String
The new IP address for the SCP server.This is the UCP Utility VM. Must besubmitted alongwith theScpServerUserName andScpServerPassword.
ScpServerUserName String
The new user name for the SCP server.The SCP user uploads firmware packagesinto UCP and does Ethernet switchconfiguration backups and restores.
ScpServerUserPassword String The new password for the SCP user.
UcpManagementIpAddress StringThe new IP address of the UCPManagement server.
WdsManagementIpAddress String The new IP address of the WDS server.
Chapter 2: UCP Director resources 153UCP Director API Reference
Configuration resources
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Update UCP configuration
Request HeaderPOST https://ucpmanagement.ucp.local/api/configuration/ucpconfigurationHTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"AmqpPassword":"Kum0@pur@1nS","AmqpUsername":"ucp","ScpServerIpAddress":"10.21.24.242","ScpServerUserName":"ucpscp","ScpServerUserPassword":"Kum0apura1nS","UcpManagementIpAddress":"10.21.24.243","WdsManagementIpAddress":"10.21.24.247""RaidcomUsername":"ucpadmin""RaidcomPassword":"Kum0@pur@1nS"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Configure UCP Settings".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get UCP Configuration
This HTTP request uses the GET method on the/api/configuration/ucpconfiguration API.
This API requires the UCP View privilege.
The body for this request must be empty.
The data in the following chart is returned. Note, however, that passwordsare not returned in the response.
154 Chapter 2: UCP Director resources
UCP Director API Reference
Configuration resources
Name Type Notes
AmqpUsername StringThe AMQP username. AMQP is a 3rd partyprotocol used for queuing UCP jobs
RaidcomUsername StringUsername for the account that hasadministrative access to the UCP resourcegroup in the G1000 storage array.
ScpServerIpAddress String The IP address of the SCP server
ScpServerUserName String The user name for the SCP server
UcpManagementIpAddress StringThe IP address of the UCP Managementserver
WdsManagementIpAddress String The IP address of the WDS server
Example: Get UCP configuration
Request HeaderGET https://ucpmanagement.ucp.local/api/configuration/ucpconfigurationHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response Body{"Id": "1","ResourceType": "Configuration","GlobalResourceId": "inst.UCP-123-456-789.cfg.1","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/configuration\/ucpconfiguration"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Configuration&targetId=inst.UCP-123-456-789.cfg.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Configuration&targetId=inst.UCP-123-456-789.cfg.1&relation=subcomponent"
Chapter 2: UCP Director resources 155UCP Director API Reference
Configuration resources
},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Configuration&targetId=inst.UCP-123-456-789.cfg.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Configuration&targetId=inst.UCP-123-456-789.cfg.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Configuration&targetId=inst.UCP-123-456-789.cfg.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Configuration&targetId=inst.UCP-123-456-789.cfg.1&relation=self%7Csubcomponent"}],"AmqpUsername": "ucp","ManagementVLanId": "63","RaidcomUsername": "ucpadmin","ScpServerIpAddress": "10.21.62.242","ScpServerUserName": "ucpscp","UcpManagementIpAddress": "10.21.63.243",In vCenter, the UCP Server Console Access privilege is required."WdsManagementIpAddress": "10.21.63.247"}
Element manager resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List server elementmanagers" on the facingpage
GET /api/serverelementmanagersUCP ServerConsole Access
156 Chapter 2: UCP Director resources
UCP Director API Reference
Elementmanager resources
Request Method URIvCenterPrivilege
"Get server elementmanager" on page 159
GET/api/serverelementmanagers/{SERVERELEMENTMANAGERID}
UCP ServerConsole Access
"Modify server elementmanager connectioninformation" on page 161
PUT/api/serverelementmanagers/{SERVERELEMENTMANAGERID}
UCP ServerAdministrator
"List storage elementmanagers" on page 162
GET /api/storageelementmanagersUCP StorageConsole Access
"Get storage elementmanager" on page 164
GET/api/storageelementmanagers/{STORAGEELEMENTMANAGERID}
UCP StorageConsole Access
"Modify storage elementmanager connectioninformation" on page 166
PUT/api/storageelementmanagers/{STORAGEELEMENTMANAGERID}
UCP StorageAdministrator
List server element managers
This HTTP request uses the GET method on the/api/serverelementmanagers URI.
In vCenter, the UCP Server Console Access privilege is required.
The body for this request must be empty.
When the request succeeds, the response body returns the properties of theserver element manager. UCP supports exactly one server element managerat this time. The properties are the same as those documented under "Getserver element manager" on page 159.
Example: List server element managers
Request HeaderGET https://ucpmanagement.ucp.local/api/serverelementmanagers HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "1","ResourceType": "ServerElementManager",
Chapter 2: UCP Director resources 157UCP Director API Reference
Elementmanager resources
"GlobalResourceId": "inst.UCP-123-456-789.cmp.1.sem.1","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverelementmanagers\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/serverelementmanagers"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=self%7Csubcomponent"}],
158 Chapter 2: UCP Director resources
UCP Director API Reference
Elementmanager resources
"ApplicationUrl":"http:\/\/10.21.62.245:23015\/ComputeSystemsManager\/index.jsp","ServerElementManagerId": "1","ServiceUrl": "http:\/\/10.21.62.245:23015\/ComputeSystemsManager\/","Username": "ucpadmin"}]
Get server element manager
This HTTP request uses the GET method on the/api/serverelementmanagers/{SERVERELEMENTMANAGERID} URI, where{SERVERELEMENTMANAGERID} specifies the ID of the server elementmanager that is to be returned.
In vCenter, the UCP Server Console Access privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the properties inthe following table.
Name Type Notes
ApplicationUrl StringThe URL used by UCP to launch a userinterface to the server element manager.
ServerElementManagerId StringID of In vCenter, the UCP Storage ConsoleAccess privilege is required.the serverelement manager.
ServiceUrl StringThe URL used by UCP tomanage theserver element manager.
Username StringThe user name used by UCP tomanagethe server element manager.
Example: Get a server element manager
Request HeaderGET https://ucpmanagement.ucp.local/api/serverelementmanagers/1 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[
Chapter 2: UCP Director resources 159UCP Director API Reference
Elementmanager resources
{"Id": "1","ResourceType": "ServerElementManager","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.sem.1","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverelementmanagers\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/serverelementmanagers"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=subcomponent"},{"Rel": "events.all",
160 Chapter 2: UCP Director resources
UCP Director API Reference
Elementmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerElementManager&targetId=inst.UCP-123-456-789.cmp.1.sem.1&relation=self%7Csubcomponent"}],"ApplicationUrl":"http:\/\/10.21.62.245:23015\/ComputeSystemsManager\/index.jsp","ServerElementManagerId": "1","ServiceUrl": "http:\/\/10.21.62.245:23015\/ComputeSystemsManager\/","Username": "ucpadmin"}}
Modify server element manager connection information
This HTTP request uses the PUT method on the/api/serverelementmanagers/{SERVERELEMENTMANAGERID} URI, where{SERVERELEMENTMANAGERID} specifies the ID of the server elementmanager with the connection information that is to be modified.
In vCenter, the UCP Server Administrator privilege is required.
This request body consists of the properties in the following table.
Name Type Notes
ApplicationUrl StringThe URL used by UCP to launch a userinterface to the server element manager.
Password String Password for the server element manager.
ServiceUrl StringThe URL used by UCP tomanage the serverelement manager.
Username StringThe user name used by UCP tomanage theserver element manager.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Modify the credentials used to access a server element manager
Request HeaderPUT https://ucpmanagement.ucp.local/api/serverelementmanagers/1 HTTP/1.1Content-Type: application/json; charset=utf-8
Chapter 2: UCP Director resources 161UCP Director API Reference
Elementmanager resources
Request Body{"ApplicationUrl":"http://10.21.24.245:23015/ComputeSystemsManager/index.jsp","Password": "Kum0@pur@1n$","ServiceUrl": "http://10.21.24.245:23015/ComputeSystemsManager","Username": "ucpadmin"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update HCSM connection information".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
List storage element managers
This HTTP request uses the GET method on the/api/storageelementmanagers URI.
In vCenter, the UCP Storage Console Access privilege is required.
The body for this request must be empty.
When the request succeeds, the response is a collection of properties aboutthe storage element manager. At this time, UCP supports just one elementmanager for storage. The properties are listed under "Get storage elementmanager" on page 164.
Example: List storage element managers
Request HeaderGET https://ucpmanagement.ucp.local/api/storageelementmanagers HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "1","ResourceType": "StorageElementManager","GlobalResourceId": "inst.UCP-123-456-789.sdm.1","InstanceId": "UCP-123-456-789",
162 Chapter 2: UCP Director resources
UCP Director API Reference
Elementmanager resources
"Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storageelementmanagers\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/storageelementmanagers"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=self%7Csubcomponent"}],"ApplicationUrl": "http:\/\/mcp-hdvm-e.mcp.com:23015\/DeviceManagerWebService\/index.jsp",
Chapter 2: UCP Director resources 163UCP Director API Reference
Elementmanager resources
"ServiceUrl": "http:\/\/mcp-hdvm-e.mcp.com:2001\/service\/StorageManager","Username": "Ucp"}]
Get storage element manager
This HTTP request uses the GET method on the/api/storageelementmanagers/{STORAGEELEMENTMANAGERID} URI,where {STORAGEELEMENTMANAGERID} specifies the ID of the storageelement manager that is to be returned.
In vCenter, the UCP Storage Console Access privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following chart.
Name Type Notes
ApplicationUrl StringThe URL used by UCP to launch the storageelement manager’s user interface.
ServiceUrl StringThe URL used by UCP tomanager thestorage element manager.
Username StringThe user name used by UCP tomanage thestorage element manager
Example: Get a storage element manager
Request HeaderGET https://ucpmanagement.ucp.local/api/storageelementmanagers/1HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "1","ResourceType": "StorageElementManager","GlobalResourceId": "inst.UCP-123-456-789.sdm.1","InstanceId": "UCP-123-456-789","Links": [{
164 Chapter 2: UCP Director resources
UCP Director API Reference
Elementmanager resources
"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storageelementmanagers\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/storageelementmanagers"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageElementManager&targetId=inst.UCP-123-456-789.sdm.1&relation=self%7Csubcomponent"}],"ApplicationUrl": "http:\/\/mcp-hdvm-e.mcp.com:23015\/DeviceManagerWebService\/index.jsp","ServiceUrl": "http:\/\/mcp-hdvm-e.mcp.com:2001\/service\/StorageManager","Username": "Ucp"
Chapter 2: UCP Director resources 165UCP Director API Reference
Elementmanager resources
}}
Modify storage element manager connection information
This HTTP request uses the PUT method on the/api/storageelementmanagers/{STORAGEELEMENTMANAGERID} URI,where {STORAGEELEMENTMANAGERID} specifies the ID of the storageelement manager with the connection information that is to be modified.
In vCenter, the UCP Storage Administrator privilege is required.
This request body consists of the properties in the following chart.
Name Type Notes
ApplicationUrl StringSpecifies the URL to be used to launch thestorage element manager's user interface.
Password StringSpecifies the password that is to be used tomanage the storage element manager.
ServiceUrl StringSpecifies the URL that is to be used toaccess the storage element manager.
Username StringSpecifies the username that is to be usedtomanage the storage element manager.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Modify the credentials used to access a storage element manager
Request HeaderPUT https://ucpmanagement.ucp.local/api/storageelementmanagers/1HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"ApplicationUrl": "http://hdvm-a.mcp.com:23015/DeviceManagerWebService/index.jsp","Password": "p@ssword1","ServiceUrl": "http://hdvm-a.mcp.com:2001/service/StorageManager","Username": "v2Prod05"}
166 Chapter 2: UCP Director resources
UCP Director API Reference
Elementmanager resources
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update HDvM connection information".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Ethernet switch resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List Ethernetswitches" onpage 169
GET /api/ethernetswitches UCP View
"Get Ethernetswitch" onpage 269
GET /api/ethernetswitches/{SWITCHID} UCP View
"Add Ethernetswitch" onpage 297
POST /api/ethernetswitchesUCP NetworkAdministrator
"RemoveEthernetswitch" onpage 298
DELETE /api/ethernetswitches/{SWITCHID}UCP NetworkAdministrator
"List Ethernetswitchconfigurations"on page 299
GET /api/ethernetswitches/{SWITCHID}/configurations UCP View
"Get Ethernetswitchconfiguration"on page 308
GET/api/ethernetswitches/{SWITCHID}/configurations/{CONFIGURATIONID}
UCP View
"CreateEthernetswitchconfigurationbackup" onpage 324
POST /api/ethernetswitches/{SWITCHID}/configurationsUCP NetworkAdministrator
Chapter 2: UCP Director resources 167UCP Director API Reference
Ethernet switch resources
Request Method URIvCenterPrivilege
"Modify a savedconfigurationbackup for anEthernetswitch" onpage 325
POST/api/ethernetswitches/{SWITCHID}/configurations/{CONFIGURATIONID}
UCP NetworkAdministrator
"DeleteEthernetswitchconfigurationbackup" onpage 326
DELETE/api/ethernetswitches/{SWITCHID}/configurations/{CONFIGURATIONID}
UCP NetworkAdministrator
"RestoreEthernetswitchconfigurationbackup" onpage 326
POST/api/ethernetswitches/{SWITCHID}/currentconfiguration
UCP NetworkAdministrator
"Get retentionpolicy forEthernetswitchconfigurationbackups " onpage 327
GET /api/ethernetswitches/configurations/retentionpolicy UCP View
"Get retentionpolicy forEthernetswitchconfigurationbackups " onpage 327
PUT /api/ethernetswitches/configurations/retentionpolicyUCP NetworkAdministrator
"Get Ethernetswitchconnectioninformation"on page 330
GET/api/ethernetswitches/{SWITCHID}/connectioninformation
UCP View
"ModifyEthernetswitchconnectioninformation"on page 332
PUT/api/ethernetswitches/{SWITCHID}/connectioninformation
UCP NetworkAdministrator
168 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
Request Method URIvCenterPrivilege
"Getunmanagedports on anEthernetswitch" onpage 334
GET/api/ethernetswitches/{SWITCHID}/unmanagedports
UCP View
"Setunmanagedports on anEthernetswitch" onpage 336
PUT/api/ethernetswitches/{SWITCHID}/unmanagedports
UCP NetworkAdministrator
"RefreshEthernetswitchinventory" onpage 337
POST /api/ethernetswitches/refreshUCP NetworkAdministrator
"Get status ofUCP Ethernetfeatures" onpage 338
GET /api/ethernetswitches/features UCP View
"Modify statusof UCPEthernetfeatures" onpage 340
POST /api/ethernetswitches/featuresUCP NetworkAdministrator
"UpdateEthernetswitchfirmware" onpage 341
POST/api/ethernetswitches/{SWITCHID}/firmwareupdates
UCP NetworkAdministrator
List Ethernet switches
This HTTP request uses the GET method on the /api/ethernetswitches URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
Chapter 2: UCP Director resources 169UCP Director API Reference
Ethernet switch resources
When the request succeeds, a list of Ethernet switches is returned. Theproperties for Ethernet switches are described under the heading "GetEthernet switch" on page 269.
Example: List all Ethernet switches
Request HeaderGET https://ucpmanagement.ucp.local/api/ethernetswitches HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "1","ResourceType": "EthernetSwitch","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=self%7Csubcomponent"},{"Rel": "events.self",
170 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Ok","IndicatorType": "Health","Name": "Temperature","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Ports","IndicatorState": "Warning","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/11","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/10","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/13","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/12","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/15","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/14","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/3","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/17","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/16",
Chapter 2: UCP Director resources 171UCP Director API Reference
Ethernet switch resources
"inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/4","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/21","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/20","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/23","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/22","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/24","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/9","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/1","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/2","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/7","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/8","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/19","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/18","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/5","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/6"],"SubResourceType": "EthernetSwitchPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 25,"NumOks": 21,"NumUnknowns": 0,"NumWarnings": 4,"ResourceState": "Warning","ResourceType": "EthernetSwitch","UpdatedDateTime": "12\/10\/2013 7:18:23 PM +00:00"},"AvailableFirmwareVersion": null,"ConnectionInformation": {"Id": "0","ResourceType": "EthernetSwitchConnectionInformation","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.cnn","InstanceId": "UCP-123-456-789","IPAddress": "10.21.62.214","Username": "ucpadmin"},"Make": "Brocade","Model": "VDX6746","Name": "R1-HI-CB500-1-U03-6746A","OSVersion": "3.0.0_dcb3","Ports": [{"Id": "TenGigabitEthernet 0\/1","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/1","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/1","MonitorIndicators": [
172 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/13"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/1","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/2","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/2","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/2","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok",
Chapter 2: UCP Director resources 173UCP Director API Reference
Ethernet switch resources
"IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/18"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/2","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/3","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/3","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/3","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,
174 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/14"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/3","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/4","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/4","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/4","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{
Chapter 2: UCP Director resources 175UCP Director API Reference
Ethernet switch resources
"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/19"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/4","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/5","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/5","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/5","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance",
176 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:23 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/5","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/6","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/6","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/6","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,
Chapter 2: UCP Director resources 177UCP Director API Reference
Ethernet switch resources
"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:23 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/6","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/7","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/7","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/7","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:23 PM +00:00"
178 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/7","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/8","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/8","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/8","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,
Chapter 2: UCP Director resources 179UCP Director API Reference
Ethernet switch resources
"PortId": "TenGigabitEthernet 0\/8","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/9","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/9","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/9","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:23 PM +00:00"},"ConnectedDevice": {"DeviceId": "a69f1b75-be4b-11e1-96a9-ba1a7ac3dd17","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/9","Vlans": "63"},
180 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
{"Id": "TenGigabitEthernet 0\/10","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/10","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/10","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "5b316cfe-b4cb-11e1-966d-f7f5fbbe1d82","DeviceType": "Server","PortId": "d0:5f:ce:01:01:20"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/10","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/11","ResourceType": "EthernetSwitchPort",
Chapter 2: UCP Director resources 181UCP Director API Reference
Ethernet switch resources
"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/11","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/11","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "d07e233f-b495-11e1-a6fc-8096535cba3e","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/11","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/12","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/12","InstanceId": "UCP-123-456-789",
182 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/12","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "03061b51-b391-11e1-8062-b3cf1df7d7fc","DeviceType": "Server","PortId": "d0:5f:ce:01:01:60"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/12","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/13","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/13","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/13",
Chapter 2: UCP Director resources 183UCP Director API Reference
Ethernet switch resources
"MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "734c28cb-b459-11e1-9ad6-db6dbff1fa28","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/13","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/14","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/14","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/14","MonitorIndicators": [{"DisplayName": "Interface Health",
184 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "33318c64-b418-11e1-abe6-9187b4949878","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/14","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/15","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/15","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/15","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth",
Chapter 2: UCP Director resources 185UCP Director API Reference
Ethernet switch resources
"SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "17e938b7-b4ab-11e1-9b52-f4232f0355b4","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/15","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/16","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/16","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/16","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},
186 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "13d1b28c-b407-11e1-aa71-d7eac8dabacd","DeviceType": "Server","PortId": "d0:5f:ce:01:01:e0"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/16","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/17","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/17","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/17","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable",
Chapter 2: UCP Director resources 187UCP Director API Reference
Ethernet switch resources
"IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bd45","DeviceType": "External","PortId": "0000.c9da.bd45"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/17","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/18","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/18","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/18","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,
188 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bd65","DeviceType": "External","PortId": "0000.c9da.bd65"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/18","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/19","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/19","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/19","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],
Chapter 2: UCP Director resources 189UCP Director API Reference
Ethernet switch resources
"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.be37","DeviceType": "External","PortId": "0000.c9da.be37"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/19","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/20","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/20","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/20","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,
190 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/20","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/21","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/21","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/21","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},
Chapter 2: UCP Director resources 191UCP Director API Reference
Ethernet switch resources
"ConnectedDevice": {"DeviceId": "0000.c9da.bdd5","DeviceType": "External","PortId": "0000.c9da.bdd5"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/21","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/22","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/22","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/22","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bde5","DeviceType": "External",
192 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"PortId": "0000.c9da.bde5"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/22","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/23","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/23","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/23","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bcf5","DeviceType": "External","PortId": "0000.c9da.bcf5"},"DeviceId": null,
Chapter 2: UCP Director resources 193UCP Director API Reference
Ethernet switch resources
"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/23","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/24","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/24","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/24","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/24","Vlans": "63"}
194 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
],"SerialNumber": "BRK0445G00S","Status": "Active","Type": "Access"},{"Id": "2","ResourceType": "EthernetSwitch","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/2"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.2&relation=subcomponent"},{"Rel": "events.all",
Chapter 2: UCP Director resources 195UCP Director API Reference
Ethernet switch resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.2&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Ok","IndicatorType": "Health","Name": "Temperature","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Ports","IndicatorState": "Warning","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/6","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/19","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/18","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/4","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/11","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/10","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/13","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/12","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/15","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/14","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/17","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/16","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/3","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/8","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/1","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/7","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/21","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/20","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/23","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/22","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/24","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/5",
196 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/2","inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/9"],"SubResourceType": "EthernetSwitchPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 25,"NumOks": 21,"NumUnknowns": 0,"NumWarnings": 4,"ResourceState": "Warning","ResourceType": "EthernetSwitch","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"AvailableFirmwareVersion": null,"ConnectionInformation": {"Id": "0","ResourceType": "EthernetSwitchConnectionInformation","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.cnn","InstanceId": "UCP-123-456-789","IPAddress": "10.21.62.215","Username": "ucpadmin"},"Make": "Brocade","Model": "VDX6746","Name": "R1-HI-CB500-1-U03-6746B","OSVersion": "3.0.0_dcb3","Ports": [{"Id": "TenGigabitEthernet 0\/1","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/1","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/1","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance",
Chapter 2: UCP Director resources 197UCP Director API Reference
Ethernet switch resources
"SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "4","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/13"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/1","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/2","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/2","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/2","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}
198 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "4","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/18"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/2","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/3","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/3","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/3","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,
Chapter 2: UCP Director resources 199UCP Director API Reference
Ethernet switch resources
"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "4","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/14"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/3","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/4","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/4","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/4","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,
200 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "4","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/19"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/4","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/5","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/5","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/5","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort",
Chapter 2: UCP Director resources 201UCP Director API Reference
Ethernet switch resources
"UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/5","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/6","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/6","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/6","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,
202 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/6","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/7","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/7","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/7","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/7","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/8","ResourceType": "EthernetSwitchPort",
Chapter 2: UCP Director resources 203UCP Director API Reference
Ethernet switch resources
"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/8","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/8","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/8","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/9","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/9","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/9","MonitorIndicators": [
204 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "a69f1b75-be4b-11e1-96a9-ba1a7ac3dd17","DeviceType": "Server","PortId": "vmnic3"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/9","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/10","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/10","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/10","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok",
Chapter 2: UCP Director resources 205UCP Director API Reference
Ethernet switch resources
"IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "5b316cfe-b4cb-11e1-966d-f7f5fbbe1d82","DeviceType": "Server","PortId": "d0:5f:ce:01:01:29"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/10","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/11","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/11","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/11","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,
206 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "d07e233f-b495-11e1-a6fc-8096535cba3e","DeviceType": "Server","PortId": "d0:5f:ce:01:01:49"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/11","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/12","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/12","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/12","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{
Chapter 2: UCP Director resources 207UCP Director API Reference
Ethernet switch resources
"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "03061b51-b391-11e1-8062-b3cf1df7d7fc","DeviceType": "Server","PortId": "d0:5f:ce:01:01:69"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/12","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/13","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/13","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/13","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance",
208 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "734c28cb-b459-11e1-9ad6-db6dbff1fa28","DeviceType": "Server","PortId": "d0:5f:ce:01:01:81"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/13","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/14","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/14","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/14","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null
Chapter 2: UCP Director resources 209UCP Director API Reference
Ethernet switch resources
}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "33318c64-b418-11e1-abe6-9187b4949878","DeviceType": "Server","PortId": "d0:5f:ce:01:01:a9"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/14","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/15","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/15","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/15","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report",
210 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "17e938b7-b4ab-11e1-9b52-f4232f0355b4","DeviceType": "Server","PortId": "d0:5f:ce:01:01:c9"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/15","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/16","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/16","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/16","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,
Chapter 2: UCP Director resources 211UCP Director API Reference
Ethernet switch resources
"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "13d1b28c-b407-11e1-aa71-d7eac8dabacd","DeviceType": "Server","PortId": "d0:5f:ce:01:01:e9"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/16","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/17","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/17","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/17","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok",
212 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bd49","DeviceType": "External","PortId": "0000.c9da.bd49"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/17","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/18","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/18","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/18","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},
Chapter 2: UCP Director resources 213UCP Director API Reference
Ethernet switch resources
"ConnectedDevice": {"DeviceId": "0000.c9da.bd69","DeviceType": "External","PortId": "0000.c9da.bd69"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/18","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/19","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/19","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/19","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.be3b","DeviceType": "External",
214 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"PortId": "0000.c9da.be3b"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/19","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/20","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/20","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/20","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,
Chapter 2: UCP Director resources 215UCP Director API Reference
Ethernet switch resources
"PortId": "TenGigabitEthernet 0\/20","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/21","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/21","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/21","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bdd9","DeviceType": "External","PortId": "0000.c9da.bdd9"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/21","Vlans": "63"},
216 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
{"Id": "TenGigabitEthernet 0\/22","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/22","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/22","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bde9","DeviceType": "External","PortId": "0000.c9da.bde9"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/22","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/23","ResourceType": "EthernetSwitchPort",
Chapter 2: UCP Director resources 217UCP Director API Reference
Ethernet switch resources
"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/23","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/23","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bcf9","DeviceType": "External","PortId": "0000.c9da.bcf9"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/23","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/24","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/24","InstanceId": "UCP-123-456-789",
218 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.2.port.TenGigabitEthernet 0\/24","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/24","Vlans": "63"}],"SerialNumber": "BRK0445G00Z","Status": "Active","Type": "Access"},{"Id": "3","ResourceType": "EthernetSwitch","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self",
Chapter 2: UCP Director resources 219UCP Director API Reference
Ethernet switch resources
"Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/3"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.3&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Ok","IndicatorType": "Health","Name": "Temperature",
220 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Fan","IndicatorState": "Ok","IndicatorType": "Health","Name": "Fan","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Power Supply","IndicatorState": "Ok","IndicatorType": "Health","Name": "PowerSupply","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Ports","IndicatorState": "Warning","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/9","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/2","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/19","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/18","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/6","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/4","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/11","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/10","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/13","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/12","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/15","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/14","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/17","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/16","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/3","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/8","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/1","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/7","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/21","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/5",
Chapter 2: UCP Director resources 221UCP Director API Reference
Ethernet switch resources
"inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/20","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/23","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/22","inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/24"],"SubResourceType": "EthernetSwitchPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 25,"NumOks": 15,"NumUnknowns": 0,"NumWarnings": 12,"ResourceState": "Warning","ResourceType": "EthernetSwitch","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"AvailableFirmwareVersion": null,"ConnectionInformation": {"Id": "0","ResourceType": "EthernetSwitchConnectionInformation","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.cnn","InstanceId": "UCP-123-456-789","IPAddress": "10.21.62.212","Username": "ucpadmin"},"Make": "Brocade","Model": "VDX6720-24","Name": "R1-BR-6720-A-U41","OSVersion": "3.0.1aa","Ports": [{"Id": "TenGigabitEthernet 0\/1","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/1","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/1","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable",
222 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "10.20.90.100","DeviceType": "External","PortId": "TenGigabitEthernet 1\/0\/7"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/1","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/2","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/2","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/2","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,
Chapter 2: UCP Director resources 223UCP Director API Reference
Ethernet switch resources
"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "10.20.90.101","DeviceType": "External","PortId": "TenGigabitEthernet 2\/0\/7"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/2","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/3","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/3","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/3","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],
224 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/3","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/4","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/4","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/4","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning",
Chapter 2: UCP Director resources 225UCP Director API Reference
Ethernet switch resources
"ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/4","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/5","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/5","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/5","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,
226 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/5","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/6","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/6","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/6","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/6","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/7",
Chapter 2: UCP Director resources 227UCP Director API Reference
Ethernet switch resources
"ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/7","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/7","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/7","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/8","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/8","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/8",
228 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/8","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/9","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/9","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/9","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,
Chapter 2: UCP Director resources 229UCP Director API Reference
Ethernet switch resources
"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/9","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/10","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/10","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/10","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance",
230 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/10","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/11","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/11","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/11","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,
Chapter 2: UCP Director resources 231UCP Director API Reference
Ethernet switch resources
"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "4","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/11"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 9,"PortId": "TenGigabitEthernet 0\/11","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/12","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/12","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/12","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,
232 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "4","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/12"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 9,"PortId": "TenGigabitEthernet 0\/12","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/13","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/13","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/13","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"
Chapter 2: UCP Director resources 233UCP Director API Reference
Ethernet switch resources
},"ConnectedDevice": {"DeviceId": "1","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/1"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/13","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/14","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/14","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/14","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "1",
234 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/3"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/14","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/15","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/15","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/15","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9cc.776d","DeviceType": "External","PortId": "0000.c9cc.776d"},
Chapter 2: UCP Director resources 235UCP Director API Reference
Ethernet switch resources
"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/15","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/16","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/16","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/16","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "4","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/16"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,
236 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"NativeVLanId": null,"PortChannelId": 9,"PortId": "TenGigabitEthernet 0\/16","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/17","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/17","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/17","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "4","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/17"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 9,"PortId": "TenGigabitEthernet 0\/17",
Chapter 2: UCP Director resources 237UCP Director API Reference
Ethernet switch resources
"Vlans": "63"},{"Id": "TenGigabitEthernet 0\/18","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/18","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/18","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "1","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/18","Vlans": "63"},{
238 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Id": "TenGigabitEthernet 0\/19","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/19","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/19","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "1","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/4"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/19","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/20","ResourceType": "EthernetSwitchPort",
Chapter 2: UCP Director resources 239UCP Director API Reference
Ethernet switch resources
"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/20","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/20","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9cc.7647","DeviceType": "External","PortId": "0000.c9cc.7647"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/20","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/21","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/21","InstanceId": "UCP-123-456-789",
240 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/21","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/21","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/22","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/22","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/22","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning",
Chapter 2: UCP Director resources 241UCP Director API Reference
Ethernet switch resources
"IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/22","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/23","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/23","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/23","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance",
242 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/23","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/24","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/24","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.3.port.TenGigabitEthernet 0\/24","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],
Chapter 2: UCP Director resources 243UCP Director API Reference
Ethernet switch resources
"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/24","Vlans": "63"}],"SerialNumber": "BKN2550G00X","Status": "Active","Type": "Aggregate"},{"Id": "4","ResourceType": "EthernetSwitch","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/4"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.4&relation=subcomponent"},{"Rel": "jobs.all",
244 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.4&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.4&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.4&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.4&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Ok","IndicatorType": "Health","Name": "Temperature","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Fan","IndicatorState": "Ok","IndicatorType": "Health","Name": "Fan","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Power Supply","IndicatorState": "Ok","IndicatorType": "Health","Name": "PowerSupply","SubGlobalResourceIds": null,"SubResourceType": null},{
Chapter 2: UCP Director resources 245UCP Director API Reference
Ethernet switch resources
"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Ports","IndicatorState": "Warning","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/9","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/6","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/21","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/20","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/23","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/1","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/22","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/24","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/4","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/7","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/2","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/19","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/18","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/5","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/8","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/11","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/10","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/13","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/12","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/15","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/14","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/3","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/17","inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/16"],"SubResourceType": "EthernetSwitchPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 25,"NumOks": 15,"NumUnknowns": 0,"NumWarnings": 12,"ResourceState": "Warning","ResourceType": "EthernetSwitch","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"AvailableFirmwareVersion": null,"ConnectionInformation": {
246 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Id": "0","ResourceType": "EthernetSwitchConnectionInformation","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.cnn","InstanceId": "UCP-123-456-789","IPAddress": "10.21.62.213","Username": "ucpadmin"},"Make": "Brocade","Model": "VDX6720-24","Name": "R1-BR-6720-B-U39","OSVersion": "3.0.1aa","Ports": [{"Id": "TenGigabitEthernet 0\/1","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/1","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/1","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "10.20.90.100","DeviceType": "External","PortId": "TenGigabitEthernet 1\/0\/8"
Chapter 2: UCP Director resources 247UCP Director API Reference
Ethernet switch resources
},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/1","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/2","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/2","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/2","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "10.20.90.101","DeviceType": "External","PortId": "TenGigabitEthernet 2\/0\/8"},"DeviceId": null,"IsConnected": true,
248 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/2","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/3","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/3","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/3","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/3","Vlans": "63"},{
Chapter 2: UCP Director resources 249UCP Director API Reference
Ethernet switch resources
"Id": "TenGigabitEthernet 0\/4","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/4","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/4","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/4","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/5","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/5","InstanceId": "UCP-123-456-789","MonitorState": {
250 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/5","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/5","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/6","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/6","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/6","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health",
Chapter 2: UCP Director resources 251UCP Director API Reference
Ethernet switch resources
"Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/6","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/7","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/7","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/7","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable",
252 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/7","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/8","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/8","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/8","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report",
Chapter 2: UCP Director resources 253UCP Director API Reference
Ethernet switch resources
"NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/8","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/9","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/9","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/9","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort",
254 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/9","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/10","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/10","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/10","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,
Chapter 2: UCP Director resources 255UCP Director API Reference
Ethernet switch resources
"PortChannelId": 10,"PortId": "TenGigabitEthernet 0\/10","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/11","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/11","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/11","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/11"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 9,"PortId": "TenGigabitEthernet 0\/11","Vlans": "63"
256 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
},{"Id": "TenGigabitEthernet 0\/12","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/12","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/12","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/12"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 9,"PortId": "TenGigabitEthernet 0\/12","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/13",
Chapter 2: UCP Director resources 257UCP Director API Reference
Ethernet switch resources
"ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/13","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/13","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "2","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/1"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/13","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/14","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/14",
258 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/14","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "2","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/3"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/14","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/15","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/15","InstanceId": "UCP-123-456-789","MonitorState": {
Chapter 2: UCP Director resources 259UCP Director API Reference
Ethernet switch resources
"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/15","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9cc.7771","DeviceType": "External","PortId": "0000.c9cc.7771"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/15","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/16","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/16","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/16","MonitorIndicators": [
260 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/16"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 9,"PortId": "TenGigabitEthernet 0\/16","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/17","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/17","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/17","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok",
Chapter 2: UCP Director resources 261UCP Director API Reference
Ethernet switch resources
"IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/17"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 9,"PortId": "TenGigabitEthernet 0\/17","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/18","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/18","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/18","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,
262 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "2","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/18","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/19","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/19","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/19","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{
Chapter 2: UCP Director resources 263UCP Director API Reference
Ethernet switch resources
"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "2","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/4"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/19","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/20","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/20","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/20","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance",
264 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9cc.764b","DeviceType": "External","PortId": "0000.c9cc.764b"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/20","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/21","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/21","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/21","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null
Chapter 2: UCP Director resources 265UCP Director API Reference
Ethernet switch resources
}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/21","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/22","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/22","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/22","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,
266 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/22","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/23","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/23","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/23","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,
Chapter 2: UCP Director resources 267UCP Director API Reference
Ethernet switch resources
"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/23","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/24","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/24","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.port.TenGigabitEthernet 0\/24","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:18:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/24","Vlans": "63"}
268 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
],"SerialNumber": "BKN2507H002","Status": "Active","Type": "Aggregate"}]
Get Ethernet switch
This HTTP request uses the GET method on the /api/ethernetswitches/{SWITCHID} URI, where {SWITCHID} specifies the ID of the Ethernetswitch that is to be returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following chart.
Name Type Notes
(Common properties) See Common properties
MonitorState CollectionCollection of monitor state information aboutthe switch.
GlobalResourceId String Global resource Id of the switch.
MonitorIndicators CollectionCollection of monitor indicators for theswitch.
DisplayName String Display name for the monitor indicator.
IndicatorState String State of indicator.
IndicatorType String Type of indicator.
Name String Name of the indicator.
SubGlobalResourceIds String
Global Ids of subresources. When the monitorindicator is “Ports”, this section will bepopulated with a comma delimited list ofEthernet switch port global Ids.
SubResourceType String
Type of the sub resource, if any. When themonitor indicator is “Ports”, theSubResourceType will be“EthernetSwitchPort”.
MonitorMode StringThe mode of reporting SNMP traps. Monitor,Report or Off.
Chapter 2: UCP Director resources 269UCP Director API Reference
Ethernet switch resources
Name Type Notes
NumErrors Int32Number of errors totaled fromSubGlobalResourceIds.
NumNotApplicables Int32Number of NAmessages totaled fromSubGlobalResourceIds.
NumOks Int32Number of OKmessages totaled fromSubGlobalResourceIds.
NumUnknowns Int32Number of Unknown messages totaled fromSubGlobalResourceIds.
NumWarnings Int32Number of Warnings totaled fromSubGlobalResourceIds.
ResourceState String Monitor state of the Ethernet switch.
ResourceType StringResource type. Always “EthernetSwitch” forEthernet switches.
UpdatedDateTime StringDate and time of the last Monitor modeaggregation.
AvailableFirmwareVersion StringFirmware which UCP has available to updatethe Ethernet switches.
ConnectionInformation CollectionConnection information that UCP uses tomanage switches.
Id StringThe identifier forEthernetSwitchConnectionInformationobject.
ResourceType StringAlways“EthernetSwitchConnectionInformation”.
GlobalResourceId StringGlobally unique Id for this collection ofconnection information.
InstanceId StringId of the UCP instance to which the switchand its connection information belongs.
IPAddress String The management IP address for the switch.
Username StringThe username used by UCP tomanage theswitch.
Make String The Ethernet switch’s manufacturer.
Model String The Ethernet switch’s model number.
Name String Friendly name of the Ethernet switch.
OSVersion String Version of the OS on the Ethernet switch.
Ports CollectionCollection of information about each port onthe switch.
270 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
Name Type Notes
(Common properties)All ports are listed, each having the propertiesdescribed under the heading Commonproperties.
MonitorState CollectionReports information about the device (host orswitch) connected on the port. Null when notconnected to a host or a switch.
MonitorIndicators Collection
A collection of monitor indicators is listed foreach port. Monitor indicators for ports are thesame as for the switch. See the upper sectionof this chart.
ConnectedDevice CollectionCollection of information about the deviceconnected to this Ethernet port.
DeviceId String Identifies the connected device.
IsConnected BooleanWhether or not the port is connected toanything. If False, the port has nothingconnected.
IsUnmanaged Boolean
Identifies if UCP does not manage it. Whenthe port is not managed, True (an option forports on aggregate switches). Otherwise,False (managed).
NativeVlanId String Native VLAN ID configured for this port.
PortChannelId Int32Identifies the Port Channel the port is a partof.
PortId String
Identifies the port of the connected device.When connected to a host, this is the nameof the host’s uplink to this port on the switch.When connected to another switch, this isthe port on the other switch.
Vlans String
The comma delimited list of VLANs configuredon the port. Each element is either a numberor a range of numbers specified with a dash.For example: “101-105, 500”.
DeviceType String
Identifies the type of the connected device.Values:
• EthernetSwitch
• Server
• Unknown
PortId String Identifies the port.
Chapter 2: UCP Director resources 271UCP Director API Reference
Ethernet switch resources
Name Type Notes
SerialNumber String The serial number of the switch.
Status String
Identifies the switch status. Values:
• Initializing
• Active
• Unreachable
• Unsupported
Type String
Identifies the type of the switch. Values:
• Access
• Aggregate
Example: Get an Ethernet switch
Request HeaderGET https://ucpmanagement.ucp.local/api/ethernetswitches/1 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "1","ResourceType": "EthernetSwitch","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=self"},
272 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Ok","IndicatorType": "Health","Name": "Temperature","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null},{
Chapter 2: UCP Director resources 273UCP Director API Reference
Ethernet switch resources
"DisplayName": "Ports","IndicatorState": "Warning","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/11","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/10","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/13","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/12","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/15","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/14","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/3","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/17","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/16","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/4","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/21","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/20","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/23","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/22","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/24","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/9","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/1","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/2","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/7","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/8","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/19","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/18","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/5","inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/6"],"SubResourceType": "EthernetSwitchPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 25,"NumOks": 21,"NumUnknowns": 0,"NumWarnings": 4,"ResourceState": "Warning","ResourceType": "EthernetSwitch","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"AvailableFirmwareVersion": null,"ConnectionInformation": {"Id": "0","ResourceType": "EthernetSwitchConnectionInformation","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.cnn","InstanceId": "UCP-123-456-789","IPAddress": "10.21.62.214","Username": "ucpadmin"},"Make": "Brocade",
274 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Model": "VDX6746","Name": "R1-HI-CB500-1-U03-6746A","OSVersion": "3.0.0_dcb3","Ports": [{"Id": "TenGigabitEthernet 0\/1","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/1","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/1","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/13"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/1","Vlans": "63"
Chapter 2: UCP Director resources 275UCP Director API Reference
Ethernet switch resources
},{"Id": "TenGigabitEthernet 0\/2","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/2","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/2","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/18"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/2","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/3",
276 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/3","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/3","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/14"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/3","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/4","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/4",
Chapter 2: UCP Director resources 277UCP Director API Reference
Ethernet switch resources
"InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/4","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "3","DeviceType": "EthernetSwitch","PortId": "TenGigabitEthernet 0\/19"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 1,"PortId": "TenGigabitEthernet 0\/4","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/5","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/5","InstanceId": "UCP-123-456-789","MonitorState": {
278 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/5","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/5","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/6","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/6","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/6","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health",
Chapter 2: UCP Director resources 279UCP Director API Reference
Ethernet switch resources
"Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/6","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/7","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/7","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/7","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable",
280 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/7","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/8","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/8","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/8","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Warning","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report",
Chapter 2: UCP Director resources 281UCP Director API Reference
Ethernet switch resources
"NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": false,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/8","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/9","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/9","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/9","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort",
282 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "a69f1b75-be4b-11e1-96a9-ba1a7ac3dd17","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/9","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/10","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/10","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/10","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {
Chapter 2: UCP Director resources 283UCP Director API Reference
Ethernet switch resources
"DeviceId": "5b316cfe-b4cb-11e1-966d-f7f5fbbe1d82","DeviceType": "Server","PortId": "d0:5f:ce:01:01:20"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/10","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/11","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/11","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/11","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "d07e233f-b495-11e1-a6fc-8096535cba3e","DeviceType": "Server","PortId": "vmnic2"
284 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/11","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/12","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/12","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/12","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "03061b51-b391-11e1-8062-b3cf1df7d7fc","DeviceType": "Server","PortId": "d0:5f:ce:01:01:60"},"DeviceId": null,"IsConnected": true,
Chapter 2: UCP Director resources 285UCP Director API Reference
Ethernet switch resources
"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/12","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/13","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/13","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/13","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "734c28cb-b459-11e1-9ad6-db6dbff1fa28","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,
286 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"PortId": "TenGigabitEthernet 0\/13","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/14","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/14","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/14","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "33318c64-b418-11e1-abe6-9187b4949878","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/14","Vlans": "63"},
Chapter 2: UCP Director resources 287UCP Director API Reference
Ethernet switch resources
{"Id": "TenGigabitEthernet 0\/15","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/15","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/15","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "17e938b7-b4ab-11e1-9b52-f4232f0355b4","DeviceType": "Server","PortId": "vmnic2"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/15","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/16","ResourceType": "EthernetSwitchPort",
288 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/16","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/16","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "13d1b28c-b407-11e1-aa71-d7eac8dabacd","DeviceType": "Server","PortId": "d0:5f:ce:01:01:e0"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/16","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/17","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/17","InstanceId": "UCP-123-456-789",
Chapter 2: UCP Director resources 289UCP Director API Reference
Ethernet switch resources
"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/17","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bd45","DeviceType": "External","PortId": "0000.c9da.bd45"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/17","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/18","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/18","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/18",
290 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bd65","DeviceType": "External","PortId": "0000.c9da.bd65"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/18","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/19","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/19","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/19","MonitorIndicators": [{"DisplayName": "Interface Health",
Chapter 2: UCP Director resources 291UCP Director API Reference
Ethernet switch resources
"IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.be37","DeviceType": "External","PortId": "0000.c9da.be37"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/19","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/20","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/20","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/20","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth",
292 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/20","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/21","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/21","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/21","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance",
Chapter 2: UCP Director resources 293UCP Director API Reference
Ethernet switch resources
"Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bdd5","DeviceType": "External","PortId": "0000.c9da.bdd5"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/21","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/22","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/22","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/22","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null
294 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bde5","DeviceType": "External","PortId": "0000.c9da.bde5"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/22","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/23","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/23","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/23","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report",
Chapter 2: UCP Director resources 295UCP Director API Reference
Ethernet switch resources
"NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": {"DeviceId": "0000.c9da.bcf5","DeviceType": "External","PortId": "0000.c9da.bcf5"},"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/23","Vlans": "63"},{"Id": "TenGigabitEthernet 0\/24","ResourceType": "EthernetSwitchPort","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/24","InstanceId": "UCP-123-456-789","MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0\/24","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,
296 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "EthernetSwitchPort","UpdatedDateTime": "12\/10\/2013 7:23:22 PM +00:00"},"ConnectedDevice": null,"DeviceId": null,"IsConnected": true,"IsUnmanaged": false,"NativeVLanId": null,"PortChannelId": 0,"PortId": "TenGigabitEthernet 0\/24","Vlans": "63"}],"SerialNumber": "BRK0445G00S","Status": "Active","Type": "Access"}
Add Ethernet switch
This HTTP request uses the POST method on the /api/ethernetswitches URI.
The process of adding an Ethernet switch to inventory includes:
• Verifying that the make, model, and OS version are supported
• Ensuring that all ports are enabled.
• Ensuring that link layer discovery protocol (LLDP/CDP) is enabled.
• When monitoring is enabled, the switch is also configured to reportSNMP traps to UCP.
When an Ethernet switch is successfully added to inventory, its state is setto Initializing.
In vCenter, the UCP Network Administrator privilege is required.
Request body
This request body consists of the properties in the following table.
Chapter 2: UCP Director resources 297UCP Director API Reference
Ethernet switch resources
Name Type Notes
IPAddress StringSpecifies the management IP address ofthe Ethernet switch that is to be added toinventory
Username String
Specifies the username to be used tomanage the Ethernet switch. May containup to 40 letters, digits, underscores orperiods.
Password String
Specifies the password to be used tomanage the Ethernet switch. Must be atleast 8 characters long and at most 40characters long.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Add an Ethernet switch to inventoryRequest HeaderPOST https://ucpmanagement.ucp.local/api/ethernetswitches HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body[{"IPAddress": "10.21.57.215","Username": "ucpadmin","Password": "Kum0@pur@1nS"}]
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Add Ethernet switch to inventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Remove Ethernet switch
This HTTP request uses the DELETE method on the /api/ethernetswitches/{SWITCHID} URI, where {SWITCHID} specifies the ID of the Ethernetswitch that is to be removed from inventory.
298 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
In vCenter, the UCP Network Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Remove an Ethernet switch from inventory
Request HeaderDELETE https://ucpmanagement.ucp.local/api/ethernetswitches/4 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Remove Ethernet switch frominventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
List Ethernet switch configurations
This HTTP request uses the GET method on the /api/ethernetswitches/{SWITCHID}/configurations URI. This API method lists all the savedconfiguration backups for the specified switch. These saved configurationsare a collection of changes that UCP has made on the switch at variouspoints in time.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body displays all of the savedconfiguration backups for the specified switch. Properties of configurationbackups are explained under the heading "Get Ethernet switchconfiguration" on page 308.
Chapter 2: UCP Director resources 299UCP Director API Reference
Ethernet switch resources
Example: List all saved configurations for an Ethernet switch
Request HeaderGEThttps://ucpmanagement.ucp.local/api/ethernetswitches/2/configurationsHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "5","ResourceType": "EthernetSwitchBackup","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.bak.5","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1\/configurations\/5"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1\/configurations"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.5&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.5&relation=subcomponent"},{"Rel": "jobs.all",
300 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.5&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.5&relation=self%7Csubcomponent"}],"Configuration": "chassis virtual-ip 10.21.62.214\/24\u000adiag postenable\u000aclass-map default\u000a match any\u000a!\u000aloggingrbridge-id 1\u000a raslog console INFO\u000a!\u000alogging syslog-server10.21.62.242\u000alogging syslog-facility local LOG_LOCAL7\u000aswitch-attributes 1\u000a chassis-name R1-HI-CB500-1-U03-6746A\u000a host-nameR1-HI-CB500-1-U03-6746A\u000a!\u000asupport rbridge-id 1\u000affdc\u000a!\u000asnmp-server contact \"Field Support.\"\u000asnmp-serverlocation \"End User Premise.\"\u000asnmp-server sys-descr \"Brocade VDXSwitch.\"\u000asnmp-server community ConvergedNetwork\u000asnmp-servercommunity OrigEquipMfr rw\u000asnmp-server community \"Secret C0de\"rw\u000asnmp-server community common\u000asnmp-server community privaterw\u000asnmp-server community public\u000asnmp-server user ucpsnmpuserauth sha auth-password * priv AES128 priv-password *\u000asnmp-serverv3host 10.21.62.243 ucpsnmpuser\u000a engineid80:00:06:34:04:55:43:50:76:32\u000a!\u000asystem-monitor fan thresholdmarginal-threshold 1 down-threshold 2\u000asystem-monitor fan alertstate removed action raslog\u000asystem-monitor power thresholdmarginal-threshold 1 down-threshold 2\u000asystem-monitor power alertstate removed action raslog\u000asystem-monitor temp threshold marginal-threshold 1 down-threshold 2\u000asystem-monitor cid-card thresholdmarginal-threshold 1 down-threshold 2\u000asystem-monitor cid-card alertstate none action none\u000asystem-monitor sfp alert state none actionnone\u000asystem-monitor compact-flash threshold marginal-threshold 1down-threshold 0\u000asystem-monitor MM threshold marginal-threshold 1down-threshold 0\u000asystem-monitor LineCard threshold marginal-
Chapter 2: UCP Director resources 301UCP Director API Reference
Ethernet switch resources
threshold 1 down-threshold 2\u000asystem-monitor LineCard alert statenone action none\u000asystem-monitor SFM threshold marginal-threshold 1down-threshold 2\u000aline vty\u000a exec-timeout 10\u000a!\u000arolename admin desc Administrator\u000arole name user desc User\u000aaaaauthentication login local\u000aaaa accounting exec default start-stopnone\u000aaaa accounting commands default start-stop none\u000aservicepassword-encryption\u000ausername admin password\"yW6TwY877I+sG3YHLzy83Q==\\n\" encryption-level 7 role admin descAdministrator\u000ausername ucpadmin password\"I3SUwZhqeUA1JQcmnMPLDw==\\n\" encryption-level 7 role admin desc \"UCPAdmin\"\u000ausername ucpsnmpuser password\"yRmhq70\/kHxTSrvwdR8Dbw==\\n\" encryption-level 7 role user desc \"UCPSNMP\"\u000ausername user password \"yW6TwY877I+sG3YHLzy83Q==\\n\"encryption-level 7 role user desc User\u000acee-map default\u000aprecedence 1\u000a priority-group-table 1 weight 40 pfc on\u000apriority-group-table 15.0 pfc off\u000a priority-group-table 15.1 pfcoff\u000a priority-group-table 15.2 pfc off\u000a priority-group-table15.3 pfc off\u000a priority-group-table 15.4 pfc off\u000a priority-group-table 15.5 pfc off\u000a priority-group-table 15.6 pfc off\u000apriority-group-table 15.7 pfc off\u000a priority-group-table 2 weight 60pfc off\u000a priority-table 2 2 2 1 2 2 2 15.0\u000a!\u000ano protocolvrrp\u000ainterface Vlan 1\u000a shutdown\u000a!\u000ainterface Vlan63\u000a description Autodeploy VLAN\u000a shutdown\u000a!\u000aprotocolspanning-tree rpvst\u000a bridge-priority 61440\u000a!\u000aprotocollldp\u000a advertise dcbx-tlv\u000a advertise optional-tlv management-address\u000a system-description Brocade VDX switch\u000a!\u000ano vlandot1q tag native\u000aip route 0.0.0.0\/0 10.21.62.1\u000aport-profiledefault\u000a vlan-profile\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan all\u000a \u000d switchporttrunk native-vlan 1\u000a !\u000a!\u000ainterface Management 1\/0\u000ano ip address dhcp\u000a ip address 10.21.62.214\/24\u000a ip gateway-address 10.21.62.1\u000a no ipv6 addressautoconfig\u000a!\u000ainterface TenGigabitEthernet 0\/1\u000a channel-group 1 mode active type standard\u000a lacp timeout long\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/2\u000a channel-group 1 mode active type standard\u000a lacp timeout long\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/3\u000a channel-group 1 mode active type standard\u000a lacp timeout long\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/4\u000a channel-group 1 mode active type standard\u000a lacp timeout long\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/5\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/6\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/7\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/8\u000a
302 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
switchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/9\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk tagnative-vlan\u000a switchport trunk native-vlan 63\u000a spanning-treeshutdown\u000a no shutdown\u000a!\u000ainterface TenGigabitEthernet0\/10\u000a switchport\u000a switchport mode trunk\u000a switchporttrunk tag native-vlan\u000a switchport trunk native-vlan 63\u000aspanning-tree shutdown\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/11\u000a switchport\u000a switchport modetrunk\u000a switchport trunk tag native-vlan\u000a switchport trunknative-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/12\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/13\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk tagnative-vlan\u000a switchport trunk native-vlan 63\u000a spanning-treeshutdown\u000a no shutdown\u000a!\u000ainterface TenGigabitEthernet0\/14\u000a switchport\u000a switchport mode trunk\u000a switchporttrunk tag native-vlan\u000a switchport trunk native-vlan 63\u000aspanning-tree shutdown\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/15\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunktag native-vlan\u000a switchport trunk native-vlan 63\u000a spanning-tree shutdown\u000a no shutdown\u000a!\u000ainterface TenGigabitEthernet0\/16\u000a switchport\u000a switchport mode trunk\u000a switchporttrunk tag native-vlan\u000a switchport trunk native-vlan 63\u000aspanning-tree shutdown\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/17\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunktag native-vlan\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/18\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunktag native-vlan\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/19\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunktag native-vlan\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/20\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunktag native-vlan\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/21\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunktag native-vlan\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/22\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunktag native-vlan\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/23\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunk
Chapter 2: UCP Director resources 303UCP Director API Reference
Ethernet switch resources
tag native-vlan\u000a no shutdown\u000a!\u000ainterfaceTenGigabitEthernet 0\/24\u000a switchport\u000a switchport modetrunk\u000a switchport trunk allowed vlan add 63\u000a switchport trunktag native-vlan\u000a no shutdown\u000a!\u000ainterface Port-channel1\u000a vlag ignore-split\u000a description Uplink ports LAG\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000a","CreatedBy": "ucp\\ucpadmin","CreatedDate": {"DateTime": "\/Date(1386686491023)\/","OffsetMinutes": 0},"Description": "Refresh Ethernet switch inventory.","Pinned": false,"SwitchId": "1","SwitchOSVersion": "3.0.0_dcb3"},{"Id": "1","ResourceType": "EthernetSwitchBackup","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.bak.1","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1\/configurations\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1\/configurations"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.1&relation=subcomponent"},{"Rel": "jobs.all",
304 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.1&relation=self%7Csubcomponent"}],"Configuration": "chassis virtual-ip 10.21.62.214\/24\u000adiag postenable\u000aclass-map default\u000a match any\u000a!\u000aloggingrbridge-id 1\u000a raslog console INFO\u000a!\u000alogging syslog-server10.21.62.242\u000alogging syslog-facility local LOG_LOCAL7\u000aswitch-attributes 1\u000a chassis-name R1-HI-CB500-1-U03-6746A\u000a host-nameR1-HI-CB500-1-U03-6746A\u000a!\u000asupport rbridge-id 1\u000affdc\u000a!\u000asnmp-server contact \"Field Support.\"\u000asnmp-serverlocation \"End User Premise.\"\u000asnmp-server sys-descr \"Brocade VDXSwitch.\"\u000asnmp-server community ConvergedNetwork\u000asnmp-servercommunity OrigEquipMfr rw\u000asnmp-server community \"Secret C0de\"rw\u000asnmp-server community common\u000asnmp-server community privaterw\u000asnmp-server community public\u000asnmp-server user ucpsnmpuserauth sha auth-password * priv AES128 priv-password *\u000asnmp-serverv3host 10.21.62.243 ucpsnmpuser\u000a engineid80:00:06:34:04:55:43:50:76:32\u000a!\u000asystem-monitor fan thresholdmarginal-threshold 1 down-threshold 2\u000asystem-monitor fan alertstate removed action raslog\u000asystem-monitor power thresholdmarginal-threshold 1 down-threshold 2\u000asystem-monitor power alertstate removed action raslog\u000asystem-monitor temp threshold marginal-threshold 1 down-threshold 2\u000asystem-monitor cid-card thresholdmarginal-threshold 1 down-threshold 2\u000asystem-monitor cid-card alertstate none action none\u000asystem-monitor sfp alert state none actionnone\u000asystem-monitor compact-flash threshold marginal-threshold 1down-threshold 0\u000asystem-monitor MM threshold marginal-threshold 1down-threshold 0\u000asystem-monitor LineCard threshold marginal-
Chapter 2: UCP Director resources 305UCP Director API Reference
Ethernet switch resources
threshold 1 down-threshold 2\u000asystem-monitor LineCard alert statenone action none\u000asystem-monitor SFM threshold marginal-threshold 1down-threshold 2\u000aline vty\u000a exec-timeout 10\u000a!\u000arolename admin desc Administrator\u000arole name user desc User\u000aaaaauthentication login local\u000aaaa accounting exec default start-stopnone\u000aaaa accounting commands default start-stop none\u000aservicepassword-encryption\u000ausername admin password\"yW6TwY877I+sG3YHLzy83Q==\\n\" encryption-level 7 role admin descAdministrator\u000ausername ucpadmin password\"I3SUwZhqeUA1JQcmnMPLDw==\\n\" encryption-level 7 role admin desc \"UCPAdmin\"\u000ausername ucpsnmpuser password\"yRmhq70\/kHxTSrvwdR8Dbw==\\n\" encryption-level 7 role user desc \"UCPSNMP\"\u000ausername user password \"yW6TwY877I+sG3YHLzy83Q==\\n\"encryption-level 7 role user desc User\u000acee-map default\u000aprecedence 1\u000a priority-group-table 1 weight 40 pfc on\u000apriority-group-table 15.0 pfc off\u000a priority-group-table 15.1 pfcoff\u000a priority-group-table 15.2 pfc off\u000a priority-group-table15.3 pfc off\u000a priority-group-table 15.4 pfc off\u000a priority-group-table 15.5 pfc off\u000a priority-group-table 15.6 pfc off\u000apriority-group-table 15.7 pfc off\u000a priority-group-table 2 weight 60pfc off\u000a priority-table 2 2 2 1 2 2 2 15.0\u000a!\u000ano protocolvrrp\u000ainterface Vlan 1\u000a shutdown\u000a!\u000ainterface Vlan63\u000a description Autodeploy VLAN\u000ashutdown\u000a!\u000ainterface Vlan 64\u000ashutdown\u000a!\u000ainterface Vlan 65\u000ashutdown\u000a!\u000ainterface Vlan 66\u000ashutdown\u000a!\u000aprotocol spanning-tree rpvst\u000a bridge-priority61440\u000a!\u000aprotocol lldp\u000a advertise dcbx-tlv\u000a advertiseoptional-tlv management-address\u000a system-description Brocade VDXswitch\u000a!\u000ano vlan dot1q tag native\u000aip route 0.0.0.0\/010.21.62.1\u000aport-profile default\u000a vlan-profile\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan all\u000a \u000d switchport trunk native-vlan 1\u000a!\u000a!\u000ainterface Management 1\/0\u000a no ip address dhcp\u000aip address 10.21.62.214\/24\u000a ip gateway-address 10.21.62.1\u000a noipv6 address autoconfig\u000a!\u000ainterface TenGigabitEthernet0\/1\u000a channel-group 1 mode active type standard\u000a lacp timeoutlong\u000a no shutdown\u000a!\u000ainterface TenGigabitEthernet0\/2\u000a channel-group 1 mode active type standard\u000a lacp timeoutlong\u000a no shutdown\u000a!\u000ainterface TenGigabitEthernet0\/3\u000a channel-group 1 mode active type standard\u000a lacp timeoutlong\u000a no shutdown\u000a!\u000ainterface TenGigabitEthernet0\/4\u000a channel-group 1 mode active type standard\u000a lacp timeoutlong\u000a no shutdown\u000a!\u000ainterface TenGigabitEthernet0\/5\u000a switchport\u000a switchport mode trunk\u000a switchport trunkallowed vlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/6\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/7\u000a
306 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
switchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/8\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/9\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 64-66\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/10\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 64-66\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/11\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 64-66\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/12\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/13\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 64-66\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/14\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 64-66\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/15\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/16\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 64-66\u000a switchport trunk tag native-vlan\u000a switchporttrunk native-vlan 63\u000a spanning-tree shutdown\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/17\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/18\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/19\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/20\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/21\u000a
Chapter 2: UCP Director resources 307UCP Director API Reference
Ethernet switch resources
switchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/22\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/23\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface TenGigabitEthernet 0\/24\u000aswitchport\u000a switchport mode trunk\u000a switchport trunk allowedvlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000ainterface Port-channel 1\u000a vlag ignore-split\u000a description Uplink ports LAG\u000a switchport\u000aswitchport mode trunk\u000a switchport trunk allowed vlan add 63-66\u000a switchport trunk tag native-vlan\u000a noshutdown\u000a!\u000a","CreatedBy": "ucp\\ucpadmin","CreatedDate": {"DateTime": "\/Date(1386686040625)\/","OffsetMinutes": 0},"Description": "Add Ethernet switch to inventory.","Pinned": false,"SwitchId": "1","SwitchOSVersion": "3.0.0_dcb3"}}
Get Ethernet switch configuration
This HTTP request uses the GET method on the /api/ethernetswitches/{SWITCHID}/configurations/{CONFIGURATIONID} URI. It returns detailsof a specific configuration backup for a specified switch.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
Name Type Notes
(Common properties) See Common properties
Configuration StringString data representing the Ethernetswitch configuration itself.
308 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
Name Type Notes
CreatedBy StringThe account name of the user that createdthe Ethernet switch configuration.Example: UCP\ucpadmin.
CreatedDate CollectionCollection of the following two date andtime properties.
DateTime DateTimeThe date/time that the Ethernet switchconfiguration was created.
OffsetMinutes Int32The time zone offset of DateTime, inminutes.
Description StringThe human-readable description for theconfiguration to be created.
Pinned BooleanWhether or not the newly createdconfiguration will be flagged as pinned.
SwitchId String
The ID of the Ethernet switch from whichthis configuration backupwas created. Usethis value for the {SWITCHID} parameteron other Ethernet switch configurationresources.
SwitchOSVersion String
The operating system version of theswitch, at the time this configurationbackupwas created. It is the switch OSversion as reported by the hardwareelement.
Example: Get a saved configuration for an Ethernet switch
Request HeaderGEThttps://ucpmanagement.ucp.local/api/ethernetswitches/1/configurations/32HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "32","ResourceType": "EthernetSwitchBackup","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.bak.32","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self",
Chapter 2: UCP Director resources 309UCP Director API Reference
Ethernet switch resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1\/configurations\/32"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1\/configurations"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.32&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.32&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.32&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.32&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.32&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchBackup&targetId=inst.UCP-123-456-789.eth.1.net.1.bak.32&relation=self%7Csubcomponent"}],
310 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Configuration": "\u000d\u000a!Command: Checkpoint cmd vdc1\u000d\u000a!Time: Fri Oct 30 19:27:582009\u000d\u000a\u000d\u000aversion 5.2(1)N1(5)\u000d\u000ahostname R1-CS-5548-A-U42\u000d\u000a\u000d\u000ano featuretelnet\u000d\u000a!#feature ssh\u000d\u000acfs ethdistribute\u000d\u000afeature private-vlan\u000d\u000afeaturelacp\u000d\u000afeature vpc\u000d\u000afeature lldp\u000d\u000afeaturefex\u000d\u000a\u000d\u000arole name priv-15\u000d\u000a descriptionThis is a system defined privilege role.\u000d\u000a rule 1 permit read-write \u000d\u000arole name priv-14\u000d\u000a description This is asystem defined privilege role.\u000d\u000a rule 1 permit read-write\u000d\u000arole name priv-13\u000d\u000a description This is a systemdefined privilege role.\u000d\u000arole name priv-12\u000d\u000adescription This is a system defined privilege role.\u000d\u000arolename priv-11\u000d\u000a description This is a system defined privilegerole.\u000d\u000arole name priv-10\u000d\u000a description This is asystem defined privilege role.\u000d\u000arole name priv-9\u000d\u000adescription This is a system defined privilege role.\u000d\u000arolename priv-8\u000d\u000a description This is a system defined privilegerole.\u000d\u000arole name priv-7\u000d\u000a description This is asystem defined privilege role.\u000d\u000arole name priv-6\u000d\u000adescription This is a system defined privilege role.\u000d\u000arolename priv-5\u000d\u000a description This is a system defined privilegerole.\u000d\u000arole name priv-4\u000d\u000a description This is asystem defined privilege role.\u000d\u000arole name priv-3\u000d\u000adescription This is a system defined privilege role.\u000d\u000arolename priv-2\u000d\u000a description This is a system defined privilegerole.\u000d\u000arole name priv-1\u000d\u000a description This is asystem defined privilege role.\u000d\u000arole name priv-0\u000d\u000adescription This is a system defined privilege role.\u000d\u000a rule 10permit command traceroute6 *\u000d\u000a rule 9 permit commandtraceroute *\u000d\u000a rule 8 permit command telnet6 *\u000d\u000arule 7 permit command telnet *\u000d\u000a rule 6 permit command ping6*\u000d\u000a rule 5 permit command ping *\u000d\u000a rule 4 permitcommand ssh6 *\u000d\u000a rule 3 permit command ssh *\u000d\u000a rule2 permit command enable *\u000d\u000a rule 1 permit read\u000d\u000ausername admin password 5 $1$fmqhaWEa$quZdfopcH.ezDuD736XX7.role network-admin\u000d\u000ausername ucpadmin password 5$1$PCNcUTQB$6hCrH5\/0iONz0vto0lrZE. role network-admin\u000d\u000ausername testadmin password 5$1$bVIT8v.q$1jOsunyc2Q35lRQIWr\/E4. role network-admin\u000d\u000ausername ucpsnmpuser password 5$1$XxuXNqte$j2cGHHG\/oFzro9juI8Pom1 role network-operator\u000d\u000a\u000d\u000abanner motd #Nexus 5000Switch#\u000d\u000a\u000d\u000assh key rsa 2048 \u000d\u000aip domain-lookup\u000d\u000aclass-map type qos class-fcoe\u000d\u000aclass-maptype queuing class-fcoe\u000d\u000a match qos-group 1\u000d\u000aclass-map type queuing class-all-flood\u000d\u000a match qos-group2\u000d\u000aclass-map type queuing class-ip-multicast\u000d\u000a matchqos-group 2\u000d\u000aclass-map type network-qos class-fcoe\u000d\u000a
Chapter 2: UCP Director resources 311UCP Director API Reference
Ethernet switch resources
match qos-group 1\u000d\u000aclass-map type network-qos class-all-flood\u000d\u000a match qos-group 2\u000d\u000aclass-map type network-qos class-ip-multicast\u000d\u000a match qos-group 2\u000d\u000apolicy-map type control-plane copp-system-policy-customized \u000d\u000a classcopp-system-class-default\u000d\u000a police cir 2048 kbps bc 6400000bytes \u000d\u000afex 110\u000d\u000a pinning max-links 1\u000d\u000adescription \"FEX110\"\u000d\u000asnmp-server user admin network-adminauth md5 0x14998da761ec16938336b100332308fa priv0x14998da761ec16938336b100332308fa localizedkey\u000d\u000asnmp-serveruser ucpadmin network-admin auth md5 0x91c55e26fe1df72d0c2a1088277bab06priv 0x91c55e26fe1df72d0c2a1088277bab06 localizedkey\u000d\u000asnmp-server user testadmin network-admin auth md50x0bf7983f38661b10143d05f1b52c0659 priv0x0bf7983f38661b10143d05f1b52c0659 localizedkey\u000d\u000asnmp-serveruser ucpsnmpuser network-operator auth sha0x523ae8cd531eec91346d1ba2b721c6ffc12a30e9 priv aes-1280x523ae8cd531eec91346d1ba2b721c6ffc12a30e9 localizedkey\u000d\u000asnmp-server host 10.21.79.243 traps version 3 priv ucpsnmpuser\u000d\u000asnmp-server host 127.0.0.1 traps version 3 priv ucpsnmpuser\u000d\u000asnmp-server enable traps callhome event-notify\u000d\u000asnmp-server enable traps callhome smtp-send-fail\u000d\u000asnmp-server enable traps cfs state-change-notif\u000d\u000asnmp-server enable traps cfs merge-failure\u000d\u000asnmp-server enable traps aaa server-state-change\u000d\u000asnmp-server enable traps upgradeUpgradeOpNotifyOnCompletion\u000d\u000asnmp-server enable traps upgradeUpgradeJobStatusNotify\u000d\u000asnmp-server enable traps feature-control FeatureOpStatusChange\u000d\u000asnmp-server enable traps sysmgrcseFailSwCoreNotifyExtended\u000d\u000asnmp-server enable traps configccmCLIRunningConfigChanged\u000d\u000asnmp-server enable traps snmpauthentication\u000d\u000asnmp-server enable traps link cisco-xcvr-mon-status-chg\u000d\u000asnmp-server enable traps vtpnotifs\u000d\u000asnmp-server enable traps vtpvlancreate\u000d\u000asnmp-server enable traps vtpvlandelete\u000d\u000asnmp-server enable traps bridgenewroot\u000d\u000asnmp-server enable traps bridgetopologychange\u000d\u000asnmp-server enable traps stpxinconsistency\u000d\u000asnmp-server enable traps stpx root-inconsistency\u000d\u000asnmp-server enable traps stpx loop-inconsistency\u000d\u000asnmp-server enable traps poeportonoff\u000d\u000asnmp-server enable traps poepwrusageon\u000d\u000asnmp-server enable traps poepwrusageoff\u000d\u000asnmp-server enable traps poepolice\u000d\u000acallhome\u000d\u000a !#destination-profile CiscoTAC-1message-level 0\u000d\u000a !#destination-profile full_txt message-level0\u000d\u000a !#destination-profile short_txt message-level0\u000d\u000a !#periodic-inventory notification interval 7\u000d\u000a!#periodic-inventory notification timeofday08:00\u000d\u000a\u000d\u000avrf context management\u000d\u000a ip route0.0.0.0\/0 10.21.79.1\u000d\u000avlan 1\u000d\u000avlan
312 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
2\u000d\u000avlan 3\u000d\u000avlan 4\u000d\u000avlan 5\u000d\u000avlan6\u000d\u000avlan 7\u000d\u000avlan 8\u000d\u000avlan 9\u000d\u000avlan10\u000d\u000avlan 11\u000d\u000avlan 12\u000d\u000avlan13\u000d\u000avlan 14\u000d\u000avlan 15\u000d\u000avlan16\u000d\u000avlan 17\u000d\u000avlan 18\u000d\u000avlan19\u000d\u000avlan 20\u000d\u000avlan 21\u000d\u000avlan22\u000d\u000avlan 23\u000d\u000avlan 25\u000d\u000avlan27\u000d\u000avlan 28\u000d\u000avlan 29\u000d\u000avlan30\u000d\u000avlan 31\u000d\u000avlan 32\u000d\u000avlan33\u000d\u000avlan 34\u000d\u000avlan 35\u000d\u000avlan36\u000d\u000avlan 37\u000d\u000avlan 79\u000d\u000avlan80\u000d\u000avlan 81\u000d\u000avlan 82\u000d\u000avlan91\u000d\u000avlan 99\u000d\u000avlan 1000\u000d\u000avlan1001\u000d\u000avlan 1002\u000d\u000avlan 1003\u000d\u000avlan1004\u000d\u000avlan 1005\u000d\u000avlan 1006\u000d\u000avlan1007\u000d\u000avlan 1008\u000d\u000avlan 1009\u000d\u000avlan1010\u000d\u000avlan 1011\u000d\u000avlan 1012\u000d\u000avlan1013\u000d\u000avlan 1014\u000d\u000avlan 1015\u000d\u000avlan1016\u000d\u000avlan 1017\u000d\u000avlan 1018\u000d\u000avlan1019\u000d\u000avlan 1020\u000d\u000avlan 1021\u000d\u000avlan1022\u000d\u000avlan 1023\u000d\u000avlan 1024\u000d\u000avlan1025\u000d\u000avlan 1026\u000d\u000avlan 1027\u000d\u000avlan1028\u000d\u000avlan 1029\u000d\u000avlan 1030\u000d\u000avlan1031\u000d\u000avlan 1032\u000d\u000avlan 1033\u000d\u000avlan1034\u000d\u000avlan 1035\u000d\u000avlan 1036\u000d\u000avlan1037\u000d\u000avlan 1038\u000d\u000avlan 1039\u000d\u000avlan1040\u000d\u000avlan 1041\u000d\u000avlan 1042\u000d\u000avlan1043\u000d\u000avlan 1044\u000d\u000avlan 1045\u000d\u000avlan1046\u000d\u000avlan 1047\u000d\u000avlan 1048\u000d\u000avlan1049\u000d\u000avlan 1050\u000d\u000avlan 1051\u000d\u000avlan1052\u000d\u000avlan 1053\u000d\u000avlan 1054\u000d\u000avlan1055\u000d\u000avlan 1056\u000d\u000avlan 1057\u000d\u000avlan1058\u000d\u000avlan 1059\u000d\u000avlan 1060\u000d\u000avlan1061\u000d\u000avlan 1062\u000d\u000avlan 1063\u000d\u000avlan1064\u000d\u000avlan 1065\u000d\u000avlan 1066\u000d\u000avlan1067\u000d\u000avlan 1068\u000d\u000avlan 1069\u000d\u000avlan1070\u000d\u000avlan 1071\u000d\u000avlan 1072\u000d\u000avlan1073\u000d\u000avlan 1074\u000d\u000avlan 1075\u000d\u000avlan1076\u000d\u000avlan 1077\u000d\u000avlan 1078\u000d\u000avlan1079\u000d\u000avlan 1080\u000d\u000avlan 1081\u000d\u000avlan1082\u000d\u000avlan 1083\u000d\u000avlan 1084\u000d\u000avlan1085\u000d\u000avlan 1086\u000d\u000avlan 1087\u000d\u000avlan1088\u000d\u000avlan 1089\u000d\u000avlan 1090\u000d\u000avlan1091\u000d\u000avlan 1092\u000d\u000avlan 1093\u000d\u000avlan1094\u000d\u000avlan 1095\u000d\u000avlan 1096\u000d\u000avlan1097\u000d\u000avlan 1098\u000d\u000avlan 1099\u000d\u000avlan1100\u000d\u000avlan 1101\u000d\u000avlan 1102\u000d\u000avlan1103\u000d\u000avlan 1104\u000d\u000avlan 1105\u000d\u000avlan1106\u000d\u000avlan 1107\u000d\u000avlan 1108\u000d\u000avlan1109\u000d\u000avlan 1110\u000d\u000avlan 1111\u000d\u000avlan
Chapter 2: UCP Director resources 313UCP Director API Reference
Ethernet switch resources
1112\u000d\u000avlan 1113\u000d\u000avlan 1114\u000d\u000avlan1115\u000d\u000avlan 1116\u000d\u000avlan 1117\u000d\u000avlan1118\u000d\u000avlan 1119\u000d\u000avlan 1120\u000d\u000avlan1121\u000d\u000avlan 1122\u000d\u000avlan 1123\u000d\u000avlan1124\u000d\u000avlan 1125\u000d\u000avlan 1126\u000d\u000avlan1127\u000d\u000avlan 1128\u000d\u000avlan 1129\u000d\u000avlan1130\u000d\u000avlan 1131\u000d\u000avlan 1132\u000d\u000avlan1133\u000d\u000avlan 1134\u000d\u000avlan 1135\u000d\u000avlan1136\u000d\u000avlan 1137\u000d\u000avlan 1138\u000d\u000avlan1139\u000d\u000avlan 1140\u000d\u000avlan 1141\u000d\u000avlan1142\u000d\u000avlan 1143\u000d\u000avlan 1144\u000d\u000avlan1145\u000d\u000avlan 1146\u000d\u000avlan 1147\u000d\u000avlan1148\u000d\u000avlan 1149\u000d\u000avlan 1150\u000d\u000avlan1151\u000d\u000avlan 1152\u000d\u000avlan 1153\u000d\u000avlan1154\u000d\u000avlan 1155\u000d\u000avlan 1156\u000d\u000avlan1157\u000d\u000avlan 1158\u000d\u000avlan 1159\u000d\u000avlan1160\u000d\u000avlan 1161\u000d\u000avlan 1162\u000d\u000avlan1163\u000d\u000avlan 1164\u000d\u000avlan 1165\u000d\u000avlan1166\u000d\u000avlan 1167\u000d\u000avlan 1168\u000d\u000avlan1169\u000d\u000avlan 1170\u000d\u000avlan 1171\u000d\u000avlan1172\u000d\u000avlan 1173\u000d\u000avlan 1174\u000d\u000avlan1175\u000d\u000avlan 1176\u000d\u000avlan 1177\u000d\u000avlan1178\u000d\u000avlan 1179\u000d\u000avlan 1180\u000d\u000avlan1181\u000d\u000avlan 1182\u000d\u000avlan 1183\u000d\u000avlan1184\u000d\u000avlan 1185\u000d\u000avlan 1186\u000d\u000avlan1187\u000d\u000avlan 1188\u000d\u000avlan 1189\u000d\u000avlan1190\u000d\u000avlan 1191\u000d\u000avlan 1192\u000d\u000avlan1193\u000d\u000avlan 1194\u000d\u000avlan 1195\u000d\u000avlan1196\u000d\u000avlan 1197\u000d\u000avlan 1198\u000d\u000avlan1199\u000d\u000avlan 1200\u000d\u000avlan 1201\u000d\u000avlan1202\u000d\u000avlan 1203\u000d\u000avlan 1204\u000d\u000avlan1205\u000d\u000avlan 1206\u000d\u000avlan 1207\u000d\u000avlan1208\u000d\u000avlan 1209\u000d\u000avlan 1210\u000d\u000avlan1211\u000d\u000avlan 1212\u000d\u000avlan 1213\u000d\u000avlan1214\u000d\u000avlan 1215\u000d\u000avlan 1216\u000d\u000avlan1217\u000d\u000avlan 1218\u000d\u000avlan 1219\u000d\u000avlan1220\u000d\u000avlan 1221\u000d\u000avlan 1222\u000d\u000avlan1223\u000d\u000avlan 1224\u000d\u000avlan 1225\u000d\u000avlan1226\u000d\u000avlan 1227\u000d\u000avlan 1228\u000d\u000avlan1229\u000d\u000avlan 1230\u000d\u000avlan 1231\u000d\u000avlan1232\u000d\u000avlan 1233\u000d\u000avlan 1234\u000d\u000avlan1235\u000d\u000avlan 1236\u000d\u000avlan 1237\u000d\u000avlan1238\u000d\u000avlan 1239\u000d\u000avlan 1240\u000d\u000avlan1241\u000d\u000avlan 1242\u000d\u000avlan 1243\u000d\u000avlan1244\u000d\u000avlan 1245\u000d\u000avlan 1246\u000d\u000avlan1247\u000d\u000avlan 1248\u000d\u000avlan 1249\u000d\u000avlan1250\u000d\u000avlan 1251\u000d\u000avlan 1252\u000d\u000avlan1253\u000d\u000avlan 1254\u000d\u000avlan 1255\u000d\u000avlan1256\u000d\u000avlan 2000\u000d\u000a private-vlan primary\u000d\u000aprivate-vlan association 2001-2002\u000d\u000avlan 2001\u000d\u000a
314 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
private-vlan community\u000d\u000avlan 2002\u000d\u000a private-vlanisolated\u000d\u000aspanning-tree port type edge bpduguarddefault\u000d\u000aspanning-tree vlan 1-3967,4048-4093 priority61440\u000d\u000avpc domain 1\u000d\u000a role priority 100\u000d\u000apeer-keepalive destination 10.21.79.213\u000d\u000aport-profile defaultmax-ports 512\u000d\u000a\u000d\u000a\u000d\u000ainterface port-channel1\u000d\u000a description vpc_peerlink\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a spanning-treeport type network\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a vpc peer-link\u000d\u000a\u000d\u000ainterface port-channel10\u000d\u000a description vpc_to_customer_network\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a spanning-treeport type normal\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a vpc 10\u000d\u000a\u000d\u000ainterface port-channel110\u000d\u000a !#switchport\u000d\u000a switchport mode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#logging event portlink-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/1\u000d\u000adescription to_customer_network\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 10 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/2\u000d\u000adescription to_customer_network\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 10 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/3\u000d\u000adescription to_customer_network\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 10 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/4\u000d\u000adescription to_customer_network\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 10 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/5\u000d\u000adescription to_customer_network\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 10 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/6\u000d\u000adescription to_customer_network\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 10 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/7\u000d\u000a
Chapter 2: UCP Director resources 315UCP Director API Reference
Ethernet switch resources
description to_customer_network\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 10 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/8\u000d\u000adescription to_customer_network\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 10 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/9\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/10\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/11\u000d\u000adescription vpc_peerlink_port\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 1 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/12\u000d\u000adescription vpc_peerlink_port\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 1 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/13\u000d\u000adescription vpc_peerlink_port\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 1 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/14\u000d\u000adescription vpc_peerlink_port\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a !#logging event port link-statusdefault\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a channel-group 1 modeactive\u000d\u000a\u000d\u000ainterface Ethernet1\/15\u000d\u000adescription management_server_port\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000aspanning-tree bpduguard enable\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet1\/16\u000d\u000adescription management_server_port\u000d\u000a !#switchport\u000d\u000aswitchport mode trunk\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000aspanning-tree bpduguard enable\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-status
316 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet1\/17\u000d\u000adescription to_n2k_110\u000d\u000a !#switchport\u000d\u000a switchportmode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a channel-group110\u000d\u000a\u000d\u000ainterface Ethernet1\/18\u000d\u000adescription to_n2k_110\u000d\u000a !#switchport\u000d\u000a switchportmode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a channel-group110\u000d\u000a\u000d\u000ainterface Ethernet1\/19\u000d\u000adescription to_n2k_110\u000d\u000a !#switchport\u000d\u000a switchportmode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a channel-group110\u000d\u000a\u000d\u000ainterface Ethernet1\/20\u000d\u000adescription to_n2k_110\u000d\u000a !#switchport\u000d\u000a switchportmode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a channel-group110\u000d\u000a\u000d\u000ainterface Ethernet1\/21\u000d\u000adescription to_n2k_110\u000d\u000a !#switchport\u000d\u000a switchportmode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a channel-group110\u000d\u000a\u000d\u000ainterface Ethernet1\/22\u000d\u000adescription to_n2k_110\u000d\u000a !#switchport\u000d\u000a switchportmode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a channel-group110\u000d\u000a\u000d\u000ainterface Ethernet1\/23\u000d\u000adescription to_n2k_110\u000d\u000a !#switchport\u000d\u000a switchportmode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a channel-group110\u000d\u000a\u000d\u000ainterface Ethernet1\/24\u000d\u000adescription to_n2k_110\u000d\u000a !#switchport\u000d\u000a switchportmode fex-fabric\u000d\u000a fex associate 110\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a channel-group110\u000d\u000a\u000d\u000ainterface Ethernet1\/25\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/26\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/27\u000d\u000a
Chapter 2: UCP Director resources 317UCP Director API Reference
Ethernet switch resources
!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/28\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/29\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/30\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/31\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet1\/32\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/1\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/2\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/3\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/4\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/5\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/6\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/7\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-
318 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/8\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/9\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/10\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/11\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/12\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/13\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/14\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/15\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface Ethernet2\/16\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a\u000d\u000ainterface mgmt0\u000d\u000a ip address10.21.79.212\/24\u000d\u000a\u000d\u000ainterfaceEthernet110\/1\/1\u000d\u000a !#switchport\u000d\u000a switchport modetrunk\u000d\u000a switchport trunk native vlan 80\u000d\u000a switchporttrunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edgetrunk\u000d\u000a !#logging event port link-status default\u000d\u000a!#logging event port trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/2\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-port
Chapter 2: UCP Director resources 319UCP Director API Reference
Ethernet switch resources
suspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/3\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/4\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/5\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 25,79-81\u000d\u000a spanning-tree port type edge trunk\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/6\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81\u000d\u000a spanning-tree port type edge trunk\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/7\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81\u000d\u000a spanning-tree port type edge trunk\u000d\u000a !#loggingevent port link-status default\u000d\u000a !#logging event port trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/8\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/9\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/10\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/11\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchport
320 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
trunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/12\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/13\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/14\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/15\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/16\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/17\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/18\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/19\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a
Chapter 2: UCP Director resources 321UCP Director API Reference
Ethernet switch resources
!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/20\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/21\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/22\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/23\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/24\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/25\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/26\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/27\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-port
322 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
suspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/28\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/29\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk native vlan 80\u000d\u000a switchport trunk allowed vlan 79-81,91,99\u000d\u000a spanning-tree port type edge trunk\u000d\u000a!#logging event port link-status default\u000d\u000a !#logging eventport trunk-status default\u000d\u000a vpc orphan-portsuspend\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/30\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 80,91,99,2002\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a switchport private-vlan host-association 20002002\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/31\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 80,91,99,2001\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a switchport private-vlan host-association 20002001\u000d\u000a\u000d\u000ainterface Ethernet110\/1\/32\u000d\u000a!#switchport\u000d\u000a switchport mode trunk\u000d\u000a switchporttrunk allowed vlan 80,91,99,2002\u000d\u000a !#logging event port link-status default\u000d\u000a !#logging event port trunk-statusdefault\u000d\u000a switchport private-vlan host-association 20002002\u000d\u000aline console\u000d\u000aline vty\u000d\u000abootkickstart bootflash:\/n5000-uk9-kickstart.5.2.1.N1.5.bin\u000d\u000abootsystem bootflash:\/n5000-uk9.5.2.1.N1.5.bin \u000d\u000alogging server192.168.100.242\u000d\u000alogging server10.21.79.242\u000d\u000a!#logging monitor\u000d\u000a!#loggingmodule\u000d\u000a!#loggingconsole\u000d\u000a\u000d\u000a\u000d\u000a\u000d\u000a","CreatedBy": "UCP\\ucpadmin","CreatedDate": {"DateTime": "\/Date(1386705177509)\/","OffsetMinutes": 0},"Description": "Create cluster from service template.","Pinned": false,"SwitchId": "1","SwitchOSVersion": "5.2(1)N1(5)"}
Chapter 2: UCP Director resources 323UCP Director API Reference
Ethernet switch resources
Create Ethernet switch configuration backup
This HTTP request uses the POST method on the /api/ethernetswitches/{SWITCHID}/configurations URI. It creates a new backup configuration forthe specified switch. Setting the property of Pinned to true will disallowautomatic deletion of this configuration backup when UCP cleans up oldbackups.
In vCenter, the UCP Network Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
Description StringThe human-readable description for theconfiguration to be created. Defaults toempty.
Pinned BooleanWhether or not the newly createdconfiguration will be flagged as pinned.Defaults to false.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Create a new Ethernet switch configuration on a given switchRequest HeaderPOSThttps://ucpmanagement.ucp.local/api/ethernetswitches/2/configurationsHTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"Description":"Production configuration","Pinned":false}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Create an Ethernet switch backup".
324 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Modify a saved configuration backup for an Ethernet switch
This HTTP request uses the POST method on the /api/ethernetswitches/{SWITCHID}/configurations/{CONFIGURATIONID} URI. This is used toedit the description or pinned value for a configuration.
In vCenter, the UCP Network Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
Description StringThe human-readable description for theconfiguration to be created. Defaults toempty.
Pinned BooleanWhether or not the newly createdconfiguration will be flagged as pinned.Defaults to false.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Update details for an Ethernet switch configuration
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/ethernetswitches/2/configurations/2HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"Description":"Production configuration","Pinned":false}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update an Ethernet switch backup".
Chapter 2: UCP Director resources 325UCP Director API Reference
Ethernet switch resources
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Delete Ethernet switch configuration backup
This HTTP request uses the DELETE method on the /api/ethernetswitches/{SWITCHID}/configurations/{CONFIGURATIONID} URI.
In vCenter, the UCP Network Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Delete an Ethernet switch configuration
Request HeaderDELETEhttps://ucpmanagement.ucp.local/api/ethernetswitches/2/configurations/2HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Delete an Ethernet switch backup".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Restore Ethernet switch configuration backup
This HTTP request uses the POST method on the /api/ethernetswitches/{SWITCHID}/currentconfiguration URI. The switch specified by{SWITCHID} will be configured with all the settings from the configurationbackup specified in the request body.
In vCenter, the UCP Network Administrator privilege is required.
The property below is required.
326 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
Name Type Notes
ConfigurationId StringThe ID of the stored configuration backupto restore onto the switch.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Restore an Ethernet switch configuration
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/ethernetswitches/2/currentconfiguration HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"ConfigurationId":"5"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Restore an Ethernet switch backup".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get retention policy for Ethernet switch configuration backups
This HTTP request uses the GET method on/api/ethernetswitches/configurations/retentionpolicy. It returns the totalnumber of backup configurations UCP is allowed to retain per switch beforepurging old ones. The other value returned is the total number of pinnedbackup configurations allowed per switch.
The body for this request must be empty.
The response body contains the data in the following table.
Chapter 2: UCP Director resources 327UCP Director API Reference
Ethernet switch resources
Name Type Notes
(Common properties) See Common properties
NumberOfPinnedBackupsPerSwitch Int32
Number of configuration backups perswitch that UCP is allowed to retain.Pinned backup configurations are thosewhich are not automatically purged byUCP
TotalNumberOfBackupsPerSwitch Int32
The total number of configurationbackups that UCP is allowed to retain. Aconfiguration backup consists of acollection of metadata regarding eachswitch and stored in UCP database.
Example: Get Ethernet switch configuration retention policy
Request HeaderGEThttps://ucpmanagement.ucp.local/api/ethernetswitches/configurations/retentionpolicy HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "0","ResourceType": "SwitchConfigurationRetentionPolicy","GlobalResourceId": "inst.UCP-123-456-789.eth.1.cfgrp","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/configurations\/retentionpolicy"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=SwitchConfigurationRetentionPolicy&targetId=inst.UCP-123-456-789.eth.1.cfgrp&relation=self"},{"Rel": "jobs.subcomponent",
328 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=SwitchConfigurationRetentionPolicy&targetId=inst.UCP-123-456-789.eth.1.cfgrp&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=SwitchConfigurationRetentionPolicy&targetId=inst.UCP-123-456-789.eth.1.cfgrp&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=SwitchConfigurationRetentionPolicy&targetId=inst.UCP-123-456-789.eth.1.cfgrp&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=SwitchConfigurationRetentionPolicy&targetId=inst.UCP-123-456-789.eth.1.cfgrp&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=SwitchConfigurationRetentionPolicy&targetId=inst.UCP-123-456-789.eth.1.cfgrp&relation=self%7Csubcomponent"}],"NumberOfPinnedBackupsPerSwitch": 99,"TotalNumberOfBackupsPerSwitch": 100}
Set retention policy for Ethernet switch configuration backups
This HTTP request uses the PUT method on/api/ethernetswitches/configurations/retentionpolicy. In the payload, onevalue specifies how many backup configurations to retain per switch andanother specifies how many pinned configuration backups are allowed perswitch. The default and maximum value for total number of backups is 100.The default and maximum value for pinned backups is 99.
Chapter 2: UCP Director resources 329UCP Director API Reference
Ethernet switch resources
Ethernet switch configuration backups are captured both manually and onevery Ethernet refresh where UCP detects a configuration change on theswitch.
The response body contains the data in the following table.
Name Type Notes
Description StringA string value which describes theconfiguration backup
Pinned Boolean Whether the backup is pinned or not
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Set retention policy for Ethernet switch configuration backups
Request HeaderPUT https://ucpmanagement.ucp.local/api/ethernetswitches/configurations/retentionpolicy HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"NumberOfPinnedBackupsPerSwitch":50,"TotalNumberOfBackupsPerSwitch":100,"ForceUpdate":true}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Set the Ethernet switch backupretention policy".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get Ethernet switch connection information
This HTTP request uses the GET method on the api/ethernetswitches/{SWITCHID}/connectioninformation URI. The connection information forthe specified switch is returned.
330 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following chart.
Name Type Notes
(Common properties) See Common properties
IPAddress String The management IP address of the switch.
Username String The username used tomanage the switch.
Example: Get connection information for an Ethernet switch
Request HeaderGEThttps://ucpmanagement.ucp.local/api/ethernetswitches/4/connectioninformation HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "0","ResourceType": "EthernetSwitchConnectionInformation","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.4.cnn","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/4\/connectioninformation"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchConnectionInformation&targetId=inst.UCP-123-456-789.eth.1.net.4.cnn&relation=self"},{"Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 331UCP Director API Reference
Ethernet switch resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchConnectionInformation&targetId=inst.UCP-123-456-789.eth.1.net.4.cnn&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchConnectionInformation&targetId=inst.UCP-123-456-789.eth.1.net.4.cnn&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchConnectionInformation&targetId=inst.UCP-123-456-789.eth.1.net.4.cnn&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchConnectionInformation&targetId=inst.UCP-123-456-789.eth.1.net.4.cnn&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchConnectionInformation&targetId=inst.UCP-123-456-789.eth.1.net.4.cnn&relation=self%7Csubcomponent"}],"IPAddress": "10.21.79.213","Username": "ucpadmin"}
Modify Ethernet switch connection information
This HTTP request uses the PUT method on the /api/ethernetswitches/{SWITCHID}/connectioninformation URI, where {SWITCHID} specifies theID of the Ethernet switch with the connection information that is to bemodified.
In vCenter, the UCP Network Administrator privilege is required.
This request body consists of the properties in the following chart.
332 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
Name Type Notes
IPAddress StringSpecifies the new management IP addressof the Ethernet switch.
Username String
Specifies the new username that is to beused tomanage the Ethernet switch. Maycontain letters, digits, underscores orperiods. The maximum length allowed is40.
Password String
Specifies the new password that is to beused tomanage the Ethernet switch. Mustbe at least 8 characters long and at most40 characters long.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Modify the credentials used to manage an Ethernet switch
Request HeaderPUThttps://ucpmanagement.ucp.local/api/ethernetswitches/4/connectioninformation HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"IPAddress": "10.21.57.215","Username": "ucpadmin","Password": "Kum0@pur@1nS"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update Ethernet switch connectioninformation".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Chapter 2: UCP Director resources 333UCP Director API Reference
Ethernet switch resources
Get unmanaged ports on an Ethernet switch
This HTTP request uses the GET method on the /api/ethernetswitches/{SWITCHID}/unmanagedports URI. The list of unmanaged ports for thespecified switch is returned. When a port is unmanaged, it is unaffectedwhen UCP configures Ethernet switch ports in either of the two followingscenarios: resetting VLAN IDs to all ports or configuring VLANs from hosts.This is important for certain blades participating on different networks fromthe ESXi blades. For example, bare-metal Windows or Linux deploymentsmight use a different set of VLAN IDs than the ESXi blades.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
Name Type Notes
(Common properties) See Common properties
UnmanagedPorts StringList of ports that will not be managed byUCP Director
When the request succeeds, the response body
Example: Get an Ethernet switch’s unmanaged ports
Request HeaderGEThttps://ucpmanagement.ucp.local/api/ethernetswitches/1/unmanagedportsHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "0","ResourceType": "EthernetSwitchUnmanagedPorts","GlobalResourceId": "inst.UCP-123-456-789.eth.1.net.1.unmngdp","InstanceId": "UCP-123-456-789","Links": [{
334 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1\/unmanagedports"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchUnmanagedPorts&targetId=inst.UCP-123-456-789.eth.1.net.1.unmngdp&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchUnmanagedPorts&targetId=inst.UCP-123-456-789.eth.1.net.1.unmngdp&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetSwitchUnmanagedPorts&targetId=inst.UCP-123-456-789.eth.1.net.1.unmngdp&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchUnmanagedPorts&targetId=inst.UCP-123-456-789.eth.1.net.1.unmngdp&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchUnmanagedPorts&targetId=inst.UCP-123-456-789.eth.1.net.1.unmngdp&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetSwitchUnmanagedPorts&targetId=inst.UCP-123-456-789.eth.1.net.1.unmngdp&relation=self%7Csubcomponent"}],"UnmanagedPorts": ["TenGigabitEthernet 0\/10","TenGigabitEthernet 0\/16"]
Chapter 2: UCP Director resources 335UCP Director API Reference
Ethernet switch resources
]
Set unmanaged ports on an Ethernet switch
This HTTP request uses the PUT method on the /api/ethernetswitches/{SWITCHID}/unmanagedports URI, where {SWITCHID} specifies the ID ofthe Ethernet switch that is to have ports designated as unmanaged.
The payload replaces the list of existing unmanaged ports. To retain theexisting list, send it along with additional ports in the payload.
Note that UCP cannot deploy templates to blades that useunmanaged switch ports.
In vCenter, the UCP Network Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
UnmanagedPortsArray ofStrings
A comma separated list of ports that willnot be managed by UCP Director.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Specify unmanaged ports on an Ethernet switch
Request HeaderPUThttps://ucpmanagement.ucp.local/api/ethernetswitches/1/unmanagedportsHTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"UnmanagedPorts": ["TenGigabitEthernet 0/1","TenGigabitEthernet 0/2","TenGigabitEthernet 0/12","TenGigabitEthernet 0/16"]]
Response HeaderHTTP/1.1 202 Accepted
336 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
Response BodyThe system executes a job named "Save Ethernet switch unmanagedports".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Refresh Ethernet switch inventory
This HTTP request uses the POST method on the/api/ethernetswitches/refresh URI.
This request accomplishes the following for every Ethernet switch ininventory:
• Discovers connectivity between switch ports and devices.
• Ensures LLDP/CPD is enabled.
• Validates and configures SNMP settings.
• Configures port channels or VPC in case of Cisco model.
• Configures Spanning Tree protocol.
• Ensures global VLANs are configured on all managed ports.
• Detects and reports unreachable and unsupported switches.
• Detects and reports host VLANs that are missing from access switchports.
In vCenter, the UCP Network Administrator privilege is required.
Request body
The body for this request must be empty.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Chapter 2: UCP Director resources 337UCP Director API Reference
Ethernet switch resources
Example: Refresh Ethernet switch inventory
Request HeaderPOST https://ucpmanagement.ucp.local/api/ethernetswitches/refreshHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Refresh Ethernet switch inventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get status of UCP Ethernet features
This HTTP request uses the GET method on the/api/ethernetswitches/features URI.
When the return value is true, UCP manages the Ethernet switch ports, portchannels, and host VLAN configurations as well as the SNMP configuration ofEthernet switches. The administrator may set the value to False whenmanagement of these features should be done manually. Note that theapplying of service templates require this value to be True.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body contains the following values.
Name Type Notes
(Common properties) See Common properties
HostNetworkConfigurationFeatureEnabled Boolean
If “True”, UCPmanages Ethernetswitch port configurations asdescribed above. If “False” UCP doesnot configure switch ports. Note thatdeployment of service templatesrequires this value to be True.
338 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
Example: Get Ethernet switches host network configurationenabled/disabled state
Request HeaderGET https://ucpmanagement.ucp.local/api/ethernetswitches/featuresHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response Body{"Id": "0","ResourceType": "EthernetFeatures","GlobalResourceId": "inst.UCP-123-456-789.eth.1.ftrs","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/features"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetFeatures&targetId=inst.UCP-123-456-789.eth.1.ftrs&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetFeatures&targetId=inst.UCP-123-456-789.eth.1.ftrs&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=EthernetFeatures&targetId=inst.UCP-123-456-789.eth.1.ftrs&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetFeatures&targetId=inst.UCP-123-456-789.eth.1.ftrs&relation=self"},
Chapter 2: UCP Director resources 339UCP Director API Reference
Ethernet switch resources
{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetFeatures&targetId=inst.UCP-123-456-789.eth.1.ftrs&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=EthernetFeatures&targetId=inst.UCP-123-456-789.eth.1.ftrs&relation=self%7Csubcomponent"}],"HostNetworkConfigurationFeatureEnabled": true}
Modify status of UCP Ethernet features
This HTTP request uses the POST method on the/api/ethernetswitches/features URI. For a discussion of the implications, see"Get status of UCP Ethernet features" on page 338.
In vCenter, the UCP Network Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
HostNetworkConfigurationFeatureEnabled Boolean
Specifies whether the Ethernet hostnetwork configuration feature shouldbe enabled or disabled. See Getstatus of UCP Ethernet features formore information.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Update Ethernet switches host network configuration to enabled
Request HeaderPOST https://ucpmanagement.ucp.local/api/ethernetswitches/featuresHTTP/1.1 Content-Type: application/json; charset=utf-8
340 Chapter 2: UCP Director resources
UCP Director API Reference
Ethernet switch resources
Request Body{"HostNetworkConfigurationFeatureEnabled":true}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update Ethernet switch features".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Update Ethernet switch firmware
This HTTP request uses the POST method on the api/ethernetswitches/{SWITCHID}/firmwareupdates URI.
This API applies the ‘pending’ firmware to the specified switch. Thefirmware file must be in UCP’s internal repository for firmware updates.During registration, this internal repository location is entered into UCPsettings. An HDS technician would upload new firmware bundles into therepository using api/updatemanagement/firmwareUpdatePackage. Thenthe UCPAdmin would schedule firmware updates and useapi/ethernetswitches/{SWITCHID}/firmwareupdates.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Update firmware on a specified Ethernet switch
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/ethernetswitches/1/firmwareupdatesHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update Ethernet Switch firmware".
Chapter 2: UCP Director resources 341UCP Director API Reference
Ethernet switch resources
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Example: Update firmware on all Ethernet switches
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/ethernetswitches/firmwareupdatesHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update Ethernet Switch firmware".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Image resourcesESXi and non-ESXi images have different repositories. Therefore, theuniversal URI path for getting image details from an image of any type is/api/servers rather than /api/repository.
The table below provides the deprecated API along with its replacement.
Request Method URIvCenterPrivilege
"List images" below GET /api/servers/images UCP View
"Get an image by ID" below GET /api/servers/images/{IMAGEID} UCP View
List images
Please see List server images under the heading Server resources.
Get an image by ID
Please see Get an image by ID under the heading Server resources.
342 Chapter 2: UCP Director resources
UCP Director API Reference
Image resources
ESXi image and repository resourcesBecause ESXi images are stored and managed in UCP repositories, the APIis constructed with “repository” in the URI. Windows and Linux images arelocated on and managed through the WDS server. Only the GET methodcan be used on Windows or Linux images. Please see Image resources fordetails.
Request Method URIvCenterPrivilege
"Create ESXi image"below
POST /api/repository/imagesUCP ServerAdministrator
"Modify ESXi image" onpage 345
PUT /api/repository/images/{IMAGEID}UCP ServerAdministrator
"Remove ESXi image" onpage 361
DELETE /api/repository/images/{IMAGEID}UCP ServerAdministrator
"Scan and update activeimages" on page 362
POST /api/repository/images/updateUCP ServerAdministrator
"List image packages" onpage 362
GET /api/repository/packages UCP View
"Get image repositorylocations" on page 365
GET /api/repository/locations UCP View
"Modify image repositorylocations" on page 366
PUT /api/repository/locationsUCP ServerAdministrator
"Get active image updatenotification recipients" onpage 367
GET /api/repository/updatenotifications UCP View
"Modify active imageupdate notificationrecipients" on page 369
PUT /api/repository/updatenotificationsUCP ServerAdministrator
"Refresh imageinventory" on page 370
POST /api/repository/images/refreshUCP ServerAdministrator
Create ESXi image
This HTTP request uses the POST method on the /api/repository/imagesURI. It applies only to ESXi images. This is essentially a clone operation.The BaseEsxiImageId is supplied in the request body. UCP makes a copy ofthe base image, giving it the the new Name and Description. Supplyingvalues for AdditionalPackages is optional.
Chapter 2: UCP Director resources 343UCP Director API Reference
ESXi image and repository resources
In vCenter, the UCP Server Administrator privilege is required.
This request’s body consists of the properties detailed in the following table.
Name Type Notes
AdditionalPackages Collection
Optionally specifies the packages to beincluded in the new image. If not null, youmust supply the following nine propertiesfor each additional package. The exactvalues for these properties can be viewedwith the GETmethod on/api/repository/packages.
AcceptanceLevel String The acceptance level of the package.
Description String Description of the package.
Id StringSpecifies the ID of the package to beincluded in the image.
Name String Name of the package.
ReleaseDate DateTime Date and time the package was released.
StatelessReady BooleanIndicates if the package is ready for usewith a stateless image.
Summary String Brief summary describing the package.
Vendor String Vendor of the package.
Version String Version of the package.
BaseEsxiImageId StringRequired. Specifies the ID of the image thatis to be cloned to create the new image.
Description StringOptional. Specifies the description of thenew image.
Name StringRequired. Specifies the name of the newimage.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Create a new ESXi imageRequest HeaderPOST https://ucpmanagement.ucp.local/api/repository/images HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"AdditionalPackages": null,
344 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
"BaseEsxiImageId": "1","Description": "Cloned copy of the ESXi image for 520HB1 blades","Name": "CloneESXiImageFor520HB1"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Create new image".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Modify ESXi image
This HTTP request uses the PUT method on the /api/repository/images/{IMAGEID} URI. The {IMAGEID} specifies the ID of the image that is to bemodified. This API applies only to ESXi images. The payload must includeall of the existing packages in the image to be modified plus any additionalpackages if needed.
In vCenter, the UCP Server Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
Description StringOptionally specifies a new description forthe image.
NewName String
Specifies a new name for the image. Thisvalue must be supplied. If the name of theimage should remain unchanged, supplythe existing image name.
Packages Collection
Specifies all of the packages to be includedin the modified image. At least onepackage is required. Use the Get andimage by Id and the List image packagesrequests to populate these objects.
AcceptanceLevel String The acceptance level of the package.
Description String Description of the package.
Id String ID of the package.
Name String Name of the package.
ReleaseDate DateTime Date and time the package was released.
Chapter 2: UCP Director resources 345UCP Director API Reference
ESXi image and repository resources
Name Type Notes
StatelessReady BooleanIndicates if the package is ready for usewith a stateless image.
Summary String Brief summary describing the package.
Vendor String Vendor of the package.
Version String Version of the package.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Modify an image
Request HeaderPUT https://ucpmanagement.ucp.local/api/repository/images/4 HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"Description": null,"NewName": "FDMHitachiESXiImage","Packages": [{"AcceptanceLevel": "VMwareCertified","Description": "Adaptec ADP94xx","Id": "VMware_bootbank_scsi-adp94xx_1.0.8.12-6vmw.510.0.0.732143","Name": "scsi-adp94xx","ReleaseDate": "/Date(1338320026040)/","StatelessReady": false,"Summary": "adp94xx: scsi driver for VMware ESX","Vendor": "VMware","Version": "1.0.8.12-6vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "This package contains miscellaneous drivers thatVMware000amaintains internally.000a000a0009vmkplexer-vmkplexer 5.1.0-None000a0009char-random 1.0-3vmw.510.0.0.732143000a0009scsi-iscsi_linux_92 1.0.0.2-3vmw.510.0.0.732143000a0009shim-libata_9_2_0_0 5.1.0-None000a0009shim-libfc_9_2_0_0 5.1.0-None000a0009net-libfcoe_921.0.24.9.2-8vmw.510.0.0.732143000a0009usbcore-usb 1.0-3vmw.510.0.0.732143000a0009hid-hid 1.0-3vmw.510.0.0.732143000a0009usb-storage-usb-storage 1.0-3vmw.510.0.0.732143000a0009net-usbnet 1.0-3vmw.510.0.0.732143000a0009net-cdc_ether 1.0-3vmw.510.0.0.732143000a0009vmklinux-vmklinux_9 5.1.0-None000a0009shim-vmklinux_9_2_0_0 5.1.0-None000a0009shim-vmklinux_9_2_1_0 5.1.0-
346 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
None000a0009shim-libfcoe_9_2_0_0 5.1.0-None000a0009ata-libata_923.00.9.2-14vmw.510.0.0.732143000a0009shim-iscsi_linux_9_2_0_0 5.1.0-None000a0009scsi-libfc_92 1.0.40.9.2-5vmw.510.0.0.732143000a0009net-fcoe1.0.29.9.2-7vmw.510.0.0.732143","Id": "VMware_bootbank_misc-drivers_5.1.0-0.0.732143","Name": "misc-drivers","ReleaseDate": "/Date(1338320024450)/","StatelessReady": false,"Summary": "Miscellaneous drivers for ESX","Vendor": "VMware","Version": "5.1.0-0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Intel(R) PRO/1000 PCI-E Network Driver","Id": "VMware_bootbank_net-e1000e_1.1.2-3vmw.510.0.0.732143","Name": "net-e1000e","ReleaseDate": "/Date(1338320024510)/","StatelessReady": false,"Summary": "e1000e: net driver for VMware ESX","Vendor": "VMware","Version": "1.1.2-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Broadcom NetXtreme II Gigabit Ethernet Driver","Id": "VMware_bootbank_net-bnx2_2.0.15g.v50.11-7vmw.510.0.0.732143","Name": "net-bnx2","ReleaseDate": "/Date(1338320026184)/","StatelessReady": false,"Summary": "bnx2: net driver for VMware ESX","Vendor": "VMware","Version": "2.0.15g.v50.11-7vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "AMD/NVidia PATA Driver","Id": "VMware_bootbank_ata-pata-amd_0.3.10-3vmw.510.0.0.732143","Name": "ata-pata-amd","ReleaseDate": "/Date(1338320026097)/","StatelessReady": false,"Summary": "pata_amd: ata driver for VMware ESX","Vendor": "VMware","Version": "0.3.10-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "ipmi driver","Id": "VMware_bootbank_ipmi-ipmi-msghandler_39.1-4vmw.510.0.0.732143","Name": "ipmi-ipmi-msghandler","ReleaseDate": "/Date(1338320025984)/","StatelessReady": false,"Summary": "ipmi_msghandler: ipmi driver for VMware ESX",
Chapter 2: UCP Director resources 347UCP Director API Reference
ESXi image and repository resources
"Vendor": "VMware","Version": "39.1-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "ESX Driver","Id": "Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560","Name": "scsi-hfcldd","ReleaseDate": "/Date(1329469024503)/","StatelessReady": false,"Summary": "hfcldd: scsi driver for VMware ESX","Vendor": "Hitachi","Version": "4.28.16.1156-1OEM.500.0.0.472560"},{"AcceptanceLevel": "VMwareCertified","Description": "HP Smart Array SCSI Driver","Id": "VMware_bootbank_scsi-hpsa_5.0.0-21vmw.510.0.0.732143","Name": "scsi-hpsa","ReleaseDate": "/Date(1338320024470)/","StatelessReady": false,"Summary": "hpsa: scsi driver for VMware ESX","Vendor": "VMware","Version": "5.0.0-21vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Emulex HBA Driver","Id": "VMware_bootbank_scsi-lpfc820_8.2.3.1-126vmw.510.0.0.732143","Name": "scsi-lpfc820","ReleaseDate": "/Date(1338320026200)/","StatelessReady": false,"Summary": "lpfc820: scsi driver for VMware ESX","Vendor": "VMware","Version": "8.2.3.1-126vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Broadcom NetXtreme II CNIC Driver","Id": "VMware_bootbank_net-cnic_1.10.2j.v50.7-3vmw.510.0.0.732143","Name": "net-cnic","ReleaseDate": "/Date(1338320026232)/","StatelessReady": false,"Summary": "cnic: net driver for VMware ESX","Vendor": "VMware","Version": "1.10.2j.v50.7-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Promise PATA Driver","Id": "VMware_bootbank_ata-pata-pdc2027x_1.0-3vmw.510.0.0.732143","Name": "ata-pata-pdc2027x","ReleaseDate": "/Date(1338320026120)/",
348 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
"StatelessReady": false,"Summary": "pata_pdc2027x: ata driver for VMware ESX","Vendor": "VMware","Version": "1.0-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Cisco FCOE HBA driver","Id": "VMware_bootbank_scsi-fnic_1.5.0.3-1vmw.510.0.0.732143","Name": "scsi-fnic","ReleaseDate": "/Date(1338320024486)/","StatelessReady": false,"Summary": "fnic: scsi driver for VMware ESX","Vendor": "VMware","Version": "1.5.0.3-1vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Adaptec aacraid driver","Id": "VMware_bootbank_scsi-aacraid_1.1.5.1-9vmw.510.0.0.732143","Name": "scsi-aacraid","ReleaseDate": "/Date(1338320026002)/","StatelessReady": false,"Summary": "aacraid: scsi driver for VMware ESX","Vendor": "VMware","Version": "1.1.5.1-9vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Cisco VIC Ethernet NIC Driver","Id": "VMware_bootbank_net-enic_1.4.2.15a-1vmw.510.0.0.732143","Name": "net-enic","ReleaseDate": "/Date(1338320025922)/","StatelessReady": false,"Summary": "enic: net driver for VMware ESX","Vendor": "VMware","Version": "1.4.2.15a-1vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Qlogic FC HBA Driver","Id": "VMware_bootbank_scsi-qla2xxx_902.k1.1-9vmw.510.0.0.732143","Name": "scsi-qla2xxx","ReleaseDate": "/Date(1338320024502)/","StatelessReady": false,"Summary": "qla2xxx: scsi driver for VMware ESX","Vendor": "VMware","Version": "902.k1.1-9vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Intel(R) 10 Gigabit Ethernet Network Driver","Id": "VMware_bootbank_net-ixgbe_3.7.13.6iov-10vmw.510.0.0.732143",
Chapter 2: UCP Director resources 349UCP Director API Reference
ESXi image and repository resources
"Name": "net-ixgbe","ReleaseDate": "/Date(1338320026224)/","StatelessReady": false,"Summary": "ixgbe: net driver for VMware ESX","Vendor": "VMware","Version": "3.7.13.6iov-10vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Promise SATA controllers Driver","Id": "VMware_bootbank_sata-sata-promise_2.12-3vmw.510.0.0.732143","Name": "sata-sata-promise","ReleaseDate": "/Date(1338320026151)/","StatelessReady": false,"Summary": "sata_promise: sata driver for VMware ESX","Vendor": "VMware","Version": "2.12-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "ipmi driver","Id": "VMware_bootbank_ipmi-ipmi-si-drv_39.1-4vmw.510.0.0.732143","Name": "ipmi-ipmi-si-drv","ReleaseDate": "/Date(1338320025994)/","StatelessReady": false,"Summary": "ipmi_si_drv: ipmi driver for VMware ESX","Vendor": "VMware","Version": "39.1-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Silicon Image 3124/3132 SATA-2 controllers Driver","Id": "VMware_bootbank_sata-sata-sil24_1.1-1vmw.510.0.0.732143","Name": "sata-sata-sil24","ReleaseDate": "/Date(1338320026168)/","StatelessReady": false,"Summary": "sata_sil24: sata driver for VMware ESX","Vendor": "VMware","Version": "1.1-1vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "LSI Logic Fusion MPT SAS driver","Id": "VMware_bootbank_scsi-mptsas_4.23.01.00-6vmw.510.0.0.732143","Name": "scsi-mptsas","ReleaseDate": "/Date(1338320026064)/","StatelessReady": false,"Summary": "mptsas: scsi driver for VMware ESX","Vendor": "VMware","Version": "4.23.01.00-6vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified",
350 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
"Description": "Broadcom NetXtreme II iSCSI HBA Driver","Id": "VMware_bootbank_scsi-bnx2i_1.9.1d.v50.1-5vmw.510.0.0.732143","Name": "scsi-bnx2i","ReleaseDate": "/Date(1338320024478)/","StatelessReady": false,"Summary": "bnx2i: scsi driver for VMware ESX","Vendor": "VMware","Version": "1.9.1d.v50.1-5vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "OneConnect 10G Network Driver","Id": "Emulex_bootbank_net-be2net_4.1.334.0-1OEM.500.0.0.472560","Name": "net-be2net","ReleaseDate": "/Date(1326140041922)/","StatelessReady": false,"Summary": "be2net: net driver for VMware ESX","Vendor": "Emulex","Version": "4.1.334.0-1OEM.500.0.0.472560"},{"AcceptanceLevel": "VMwareCertified","Description": "Highpoint Technology HPT3x2n PATA Driver","Id": "VMware_bootbank_ata-pata-hpt3x2n_0.3.4-3vmw.510.0.0.732143","Name": "ata-pata-hpt3x2n","ReleaseDate": "/Date(1338320026113)/","StatelessReady": false,"Summary": "pata_hpt3x2n: ata driver for VMware ESX","Vendor": "VMware","Version": "0.3.4-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Intel(R) PRO/1000 Network Driver","Id": "VMware_bootbank_net-e1000_8.0.3.1-2vmw.510.0.0.732143","Name": "net-e1000","ReleaseDate": "/Date(1338320026249)/","StatelessReady": false,"Summary": "e1000: net driver for VMware ESX","Vendor": "VMware","Version": "8.0.3.1-2vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Serverworks PATA Driver","Id": "VMware_bootbank_ata-pata-serverworks_0.4.3-3vmw.510.0.0.732143","Name": "ata-pata-serverworks","ReleaseDate": "/Date(1338320026128)/","StatelessReady": false,"Summary": "pata_serverworks: ata driver for VMware ESX","Vendor": "VMware","Version": "0.4.3-3vmw.510.0.0.732143"},
Chapter 2: UCP Director resources 351UCP Director API Reference
ESXi image and repository resources
{"AcceptanceLevel": "VMwareCertified","Description": "SIL680 IDE/PATA Controller Driver","Id": "VMware_bootbank_ata-pata-sil680_0.4.8-3vmw.510.0.0.732143","Name": "ata-pata-sil680","ReleaseDate": "/Date(1338320026135)/","StatelessReady": false,"Summary": "pata_sil680: ata driver for VMware ESX","Vendor": "VMware","Version": "0.4.8-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Broadcom NetXtreme II CNIC Registration Agent","Id": "VMware_bootbank_misc-cnic-register_1.1-1vmw.510.0.0.732143","Name": "misc-cnic-register","ReleaseDate": "/Date(1338320026240)/","StatelessReady": false,"Summary": "cnic_register: misc driver for VMware ESX","Vendor": "VMware","Version": "1.1-1vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareAccepted","Description": "Hitachi CIM Provider for FC-HBA","Id": "Hitachi_bootbank_hfc_1.28.16-30","Name": "hfc","ReleaseDate": "/Date(1332248394774)/","StatelessReady": false,"Summary": "Hitachi FC-HBA 1.28.16-30","Vendor": "Hitachi","Version": "1.28.16-30"},{"AcceptanceLevel": "VMwareCertified","Description": "Neterion Inc. Xframe II 10 Gb Ethernet driver","Id": "VMware_bootbank_net-s2io_2.1.4.13427-3vmw.510.0.0.732143","Name": "net-s2io","ReleaseDate": "/Date(1338320025961)/","StatelessReady": false,"Summary": "s2io: net driver for VMware ESX","Vendor": "VMware","Version": "2.1.4.13427-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Intel(R) Gigabit Ethernet Network Driver","Id": "VMware_bootbank_net-igb_2.1.11.1-3vmw.510.0.0.732143","Name": "net-igb","ReleaseDate": "/Date(1338320025953)/","StatelessReady": false,"Summary": "igb: net driver for VMware ESX","Vendor": "VMware",
352 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
"Version": "2.1.11.1-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "aic79xx driver","Id": "VMware_bootbank_scsi-aic79xx_3.1-5vmw.510.0.0.732143","Name": "scsi-aic79xx","ReleaseDate": "/Date(1338320026032)/","StatelessReady": false,"Summary": "aic79xx: scsi driver for VMware ESX","Vendor": "VMware","Version": "3.1-5vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Intel rste SAS driver","Id": "VMware_bootbank_scsi-rste_2.0.2.0088-1vmw.510.0.0.732143","Name": "scsi-rste","ReleaseDate": "/Date(1338320050365)/","StatelessReady": false,"Summary": "rste: SAS driver for VMware ESX","Vendor": "VMware","Version": "2.0.2.0088-1vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "AHCI SATA controllers Driver","Id": "VMware_bootbank_sata-ahci_3.0-12vmw.510.0.0.732143","Name": "sata-ahci","ReleaseDate": "/Date(1338320026143)/","StatelessReady": false,"Summary": "ahci: sata driver for VMware ESX","Vendor": "VMware","Version": "3.0-12vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "CMD64x PATA Driver","Id": "VMware_bootbank_ata-pata-cmd64x_0.2.5-3vmw.510.0.0.732143","Name": "ata-pata-cmd64x","ReleaseDate": "/Date(1338320026105)/","StatelessReady": false,"Summary": "pata_cmd64x: ata driver for VMware ESX","Vendor": "VMware","Version": "0.2.5-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Adaptec IPS","Id": "VMware_bootbank_scsi-ips_7.12.05-4vmw.510.0.0.732143","Name": "scsi-ips","ReleaseDate": "/Date(1338320026048)/","StatelessReady": false,
Chapter 2: UCP Director resources 353UCP Director API Reference
ESXi image and repository resources
"Summary": "ips: scsi driver for VMware ESX","Vendor": "VMware","Version": "7.12.05-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Driver for HP/Compaq Smart Array Controllers","Id": "VMware_bootbank_block-cciss_3.6.14-10vmw.510.0.0.732143","Name": "block-cciss","ReleaseDate": "/Date(1338320026191)/","StatelessReady": false,"Summary": "cciss: block driver for VMware ESX","Vendor": "VMware","Version": "3.6.14-10vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Silicon Image SATA controllers Driver","Id": "VMware_bootbank_sata-sata-sil_2.3-4vmw.510.0.0.732143","Name": "sata-sata-sil","ReleaseDate": "/Date(1338320026160)/","StatelessReady": false,"Summary": "sata_sil: sata driver for VMware ESX","Vendor": "VMware","Version": "2.3-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "LSI MegaRAID SAS Driver","Id": "VMware_bootbank_scsi-megaraid-sas_5.34-4vmw.510.0.0.732143","Name": "scsi-megaraid-sas","ReleaseDate": "/Date(1338320026010)/","StatelessReady": false,"Summary": "megaraid_sas: scsi driver for VMware ESX","Vendor": "VMware","Version": "5.34-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "BroadCom/ServerWorks/Apple SATA controllers Driver","Id": "VMware_bootbank_sata-sata-svw_2.3-3vmw.510.0.0.732143","Name": "sata-sata-svw","ReleaseDate": "/Date(1338320026176)/","StatelessReady": false,"Summary": "sata_svw: sata driver for VMware ESX","Vendor": "VMware","Version": "2.3-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "USB 2.0 ehci host driver","Id": "VMware_bootbank_ehci-ehci-hcd_1.0-3vmw.510.0.0.732143","Name": "ehci-ehci-hcd",
354 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
"ReleaseDate": "/Date(1338320026287)/","StatelessReady": false,"Summary": "ehci-hcd: ehci driver for VMware ESX","Vendor": "VMware","Version": "1.0-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Realtek 8169","Id": "VMware_bootbank_net-r8169_6.011.00-2vmw.510.0.0.732143","Name": "net-r8169","ReleaseDate": "/Date(1338320024518)/","StatelessReady": false,"Summary": "r8169: net driver for VMware ESX","Vendor": "VMware","Version": "6.011.00-2vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Broadcom 10G Network Driver","Id": "VMware_bootbank_net-bnx2x_1.61.15.v50.3-1vmw.510.0.0.732143","Name": "net-bnx2x","ReleaseDate": "/Date(1338320024526)/","StatelessReady": false,"Summary": "bnx2x: net driver for VMware ESX","Vendor": "VMware","Version": "1.61.15.v50.3-1vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Marvell Yukon 2 driver","Id": "VMware_bootbank_net-sky2_1.20-2vmw.510.0.0.732143","Name": "net-sky2","ReleaseDate": "/Date(1338320025937)/","StatelessReady": false,"Summary": "sky2: net driver for VMware ESX","Vendor": "VMware","Version": "1.20-2vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "This package contains dvfilter-generic-fastpathmodule.","Id": "VMware_bootbank_esx-dvfilter-generic-fastpath_5.1.0-0.0.732143","Name": "esx-dvfilter-generic-fastpath","ReleaseDate": "/Date(1338320050338)/","StatelessReady": false,"Summary": "dvfilter-generic-fastpath module","Vendor": "VMware","Version": "5.1.0-0.0.732143"},{"AcceptanceLevel": "VMwareCertified",
Chapter 2: UCP Director resources 355UCP Director API Reference
ESXi image and repository resources
"Description": "Broadcom NetXtreme I Gigabit Ethernet Driver","Id": "VMware_bootbank_net-tg3_3.110h.v50.4-4vmw.510.0.0.732143","Name": "net-tg3","ReleaseDate": "/Date(1338320025945)/","StatelessReady": false,"Summary": "tg3: net driver for VMware ESX","Vendor": "VMware","Version": "3.110h.v50.4-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Intel PATA/SATA controllers Driver","Id": "VMware_bootbank_sata-ata-piix_2.12-5vmw.510.0.0.732143","Name": "sata-ata-piix","ReleaseDate": "/Date(1338320026208)/","StatelessReady": false,"Summary": "ata_piix: sata driver for VMware ESX","Vendor": "VMware","Version": "2.12-5vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "USB 1.0 uhci host driver","Id": "VMware_bootbank_uhci-usb-uhci_1.0-3vmw.510.0.0.732143","Name": "uhci-usb-uhci","ReleaseDate": "/Date(1338320026302)/","StatelessReady": false,"Summary": "usb-uhci: uhci driver for VMware ESX","Vendor": "VMware","Version": "1.0-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "LSI Logic MegaRAID Driver","Id": "VMware_bootbank_scsi-megaraid2_2.00.4-9vmw.510.0.0.732143","Name": "scsi-megaraid2","ReleaseDate": "/Date(1338320026017)/","StatelessReady": false,"Summary": "megaraid2: scsi driver for VMware ESX","Vendor": "VMware","Version": "2.00.4-9vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "LSI Logic Fusion MPT SPI driver","Id": "VMware_bootbank_scsi-mptspi_4.23.01.00-6vmw.510.0.0.732143","Name": "scsi-mptspi","ReleaseDate": "/Date(1338320026216)/","StatelessReady": false,"Summary": "mptspi: scsi driver for VMware ESX","Vendor": "VMware","Version": "4.23.01.00-6vmw.510.0.0.732143"},
356 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
{"AcceptanceLevel": "VMwareCertified","Description": "VMware vmxnet3","Id": "VMware_bootbank_net-vmxnet3_1.1.3.0-3vmw.510.0.0.732143","Name": "net-vmxnet3","ReleaseDate": "/Date(1338320025913)/","StatelessReady": false,"Summary": "vmxnet3: net driver for VMware ESX","Vendor": "VMware","Version": "1.1.3.0-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "USB 1.0 ohci host driver","Id": "VMware_bootbank_ohci-usb-ohci_1.0-3vmw.510.0.0.732143","Name": "ohci-usb-ohci","ReleaseDate": "/Date(1338320026294)/","StatelessReady": false,"Summary": "usb-ohci: ohci driver for VMware ESX","Vendor": "VMware","Version": "1.0-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Realtek 8168","Id": "VMware_bootbank_net-r8168_8.013.00-3vmw.510.0.0.732143","Name": "net-r8168","ReleaseDate": "/Date(1338320024494)/","StatelessReady": false,"Summary": "r8168: net driver for VMware ESX","Vendor": "VMware","Version": "8.013.00-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "ipmi driver","Id": "VMware_bootbank_ipmi-ipmi-devintf_39.1-4vmw.510.0.0.732143","Name": "ipmi-ipmi-devintf","ReleaseDate": "/Date(1338320025976)/","StatelessReady": false,"Summary": "ipmi_devintf: ipmi driver for VMware ESX","Vendor": "VMware","Version": "39.1-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "LSI Fusion MPT2 6G SAS driver","Id": "VMware_bootbank_scsi-mpt2sas_10.00.00.00-5vmw.510.0.0.732143","Name": "scsi-mpt2sas","ReleaseDate": "/Date(1338320026056)/","StatelessReady": false,"Summary": "mpt2sas: scsi driver for VMware ESX","Vendor": "VMware",
Chapter 2: UCP Director resources 357UCP Director API Reference
ESXi image and repository resources
"Version": "10.00.00.00-5vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "This package contains cdrom and floppy images used toinstall the tools inside virtual machines.","Id": "VMware_locker_tools-light_5.1.0-0.0.732143","Name": "tools-light","ReleaseDate": "/Date(1338320050288)/","StatelessReady": false,"Summary": "ESXi tools","Vendor": "VMware","Version": "5.1.0-0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Qlogic iSCSI HBA Driver","Id": "VMware_bootbank_scsi-qla4xxx_5.01.03.2-4vmw.510.0.0.732143","Name": "scsi-qla4xxx","ReleaseDate": "/Date(1338320026259)/","StatelessReady": false,"Summary": "qla4xxx: scsi driver for VMware ESX","Vendor": "VMware","Version": "5.01.03.2-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "X.Org base libraries.","Id": "VMware_bootbank_esx-xlibs_5.1.0-0.0.732143","Name": "esx-xlibs","ReleaseDate": "/Date(1338320050313)/","StatelessReady": false,"Summary": "ESXi X.Org base libraries","Vendor": "VMware","Version": "5.1.0-0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "nVidia SATA controllers Driver","Id": "VMware_bootbank_sata-sata-nv_3.5-4vmw.510.0.0.732143","Name": "sata-sata-nv","ReleaseDate": "/Date(1338320026073)/","StatelessReady": false,"Summary": "sata_nv: sata driver for VMware ESX","Vendor": "VMware","Version": "3.5-4vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "LSI Logic MegaRAID Driver (New Driver)","Id": "VMware_bootbank_scsi-megaraid-mbox_2.20.5.1-6vmw.510.0.0.732143","Name": "scsi-megaraid-mbox","ReleaseDate": "/Date(1338320026025)/",
358 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
"StatelessReady": false,"Summary": "megaraid_mbox: scsi driver for VMware ESX","Vendor": "VMware","Version": "2.20.5.1-6vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "NetXen 10G Ethernet Driver","Id": "VMware_bootbank_net-nx-nic_4.0.558-3vmw.510.0.0.732143","Name": "net-nx-nic","ReleaseDate": "/Date(1338320024536)/","StatelessReady": false,"Summary": "nx_nic: net driver for VMware ESX","Vendor": "VMware","Version": "4.0.558-3vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "VMware ESXi is a thin hypervisor integrated into serverhardware. The compact, hardware embedded architecture of VMware ESXiraises the bar for security and reliability and lays the foundation fora dynamic, automated datacenter.","Id": "VMware_bootbank_esx-base_5.1.0-0.0.732143","Name": "esx-base","ReleaseDate": "/Date(1338320048787)/","StatelessReady": false,"Summary": "ESXi base system","Vendor": "VMware","Version": "5.1.0-0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "nVidia forcedeth driver","Id": "VMware_bootbank_net-forcedeth_0.61-2vmw.510.0.0.732143","Name": "net-forcedeth","ReleaseDate": "/Date(1338320025930)/","StatelessReady": false,"Summary": "forcedeth: net driver for VMware ESX","Vendor": "VMware","Version": "0.61-2vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "ATI SATA Controllers Driver","Id": "VMware_bootbank_ata-pata-atiixp_0.4.6-4vmw.510.0.0.732143","Name": "ata-pata-atiixp","ReleaseDate": "/Date(1338320026082)/","StatelessReady": false,"Summary": "pata_atiixp: ata driver for VMware ESX","Vendor": "VMware","Version": "0.4.6-4vmw.510.0.0.732143"},{
Chapter 2: UCP Director resources 359UCP Director API Reference
ESXi image and repository resources
"AcceptanceLevel": "VMwareCertified","Description": "VIA SATA Controllers Driver","Id": "VMware_bootbank_ata-pata-via_0.3.3-2vmw.510.0.0.732143","Name": "ata-pata-via","ReleaseDate": "/Date(1338320026090)/","StatelessReady": false,"Summary": "pata_via: ata driver for VMware ESX","Vendor": "VMware","Version": "0.3.3-2vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "Esxi Trusted boot uses Intel TXT to do a \"secure launchof ESXi hypervisor\".","Id": "VMware_bootbank_esx-tboot_5.1.0-0.0.732143","Name": "esx-tboot","ReleaseDate": "/Date(1338320048797)/","StatelessReady": false,"Summary": "ESXi Trusted Boot","Vendor": "VMware","Version": "5.1.0-0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "X.Org Xserver and supporting libraries for OpenGLsupport.","Id": "VMware_bootbank_esx-xserver_5.1.0-0.0.732143","Name": "esx-xserver","ReleaseDate": "/Date(1338320050317)/","StatelessReady": false,"Summary": "ESXi X.Org Xserver","Vendor": "VMware","Version": "5.1.0-0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "QLogic IMA plugin for 4xxx iSCSI devices.","Id": "VMware_bootbank_ima-qla4xxx_2.01.31-1vmw.510.0.0.732143","Name": "ima-qla4xxx","ReleaseDate": "/Date(1338320026263)/","StatelessReady": false,"Summary": "qima4xxx: IMA plugin for VMware ESX","Vendor": "VMware","Version": "2.01.31-1vmw.510.0.0.732143"},{"AcceptanceLevel": "VMwareCertified","Description": "This package provides the High Availability services forvCenter","Id": "VMware_bootbank_vmware-fdm_5.1.0-716946","Name": "vmware-fdm","ReleaseDate": "/Date(1336928450416)/","StatelessReady": true,
360 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
"Summary": "VMware Fault Domain Manager","Vendor": "VMware","Version": "5.1.0-716946"}]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Edit image".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Remove ESXi image
This HTTP request uses the DELETE method on the /api/repository/images/{IMAGEID} URI, where {IMAGEID} specifies the ID of the image that is tobe removed. This API applies only to ESXi images.
In vCenter, the UCP Server Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Remove an ESXi image
Applicable only to ESXi images and must be directed through the/repository/images API.
Request HeaderDELETE https://ucpmanagement.ucp.local/api/repository/images/20 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Delete images from image repository".
Chapter 2: UCP Director resources 361UCP Director API Reference
ESXi image and repository resources
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Scan and update active images
This HTTP request uses the POST method on the/api/repository/images/update URI. With this API, UCP will check all knownESXi image repository locations for updated versions of packages used byactive ESXi images. An ESXi image is active when it is applied to a server.Upon finding newer packages, UCP creates a copy of the active image, addsthe new package to it and notifies the user by email. See “Get active imageupdate notification recipients”.
In vCenter, the UCP Server Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Update active images
Request HeaderPOST https://ucpmanagement.ucp.local/api/repository/images/updateHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update active images".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
List image packages
This HTTP request uses the GET method on the /api/repository/packagesURI. Packages are ESXi driver bundles, also known as VIBs (or VMwareInstallatino Bundle). This API applies only to ESXi images.
In vCenter, the UCP View privilege is required.
362 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
The body for this request must be empty.
When the request succeeds, the response body consists of an array ofobjects (one object for each package) containing the properties detailed inthe following table.
Name Type Notes
(Common properties) See Common properties.
AcceptanceLevel String
Acceptance level of the package. Values:
• VMwareCertified: VIBs created and testedby VMware. VMware Certified VIBs undergothorough testing by VMware.
• VMwareAccepted: VIBs created by aVMware partners that are approved byVMware. VMware relies on partners toperform the testing, but VMware verifiesthe results.
• PartnerSupported: VIBs created andtested by a trusted VMware partner. Thepartner performs all testing. VMware doesnot verify the results.
• CommunitySupported: VIBs created byindividuals or partners outside of theVMware partner program. These VIBs donot undergo any VMware or trusted partnertesting and are not supported by VMware orits partners.
Description String Description of the package.
Name String Name of the package.
ReleaseDate DateTime Date and time the package was released.
StatelessReady Boolean
Indicates if the package is ready for usewith a stateless image. Images containingpackages that are not stateless ready canbe used. However, each reboot is treatedlike a fresh install and configuration data isnot available across reboots like it is with astateless ready image.
Summary String Brief summary describing the package.
Vendor String Vendor of the package.
Version String Version of the package.
Chapter 2: UCP Director resources 363UCP Director API Reference
ESXi image and repository resources
Example: List packages
For the sake of brevity, just one package is listed in this example.
Request HeaderGET https://ucpmanagement.ucp.local/api/repository/packages HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560","InstanceId": "UCP-123-456-789","Links": [{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/repository\/packages"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Package&targetId=inst.UCP-123-456-789.pkg.Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Package&targetId=inst.UCP-123-456-789.pkg.Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Package&targetId=inst.UCP-123-456-789.pkg.Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560&relation=self%7Csubcomponent"},{"Rel": "events.self",
364 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Package&targetId=inst.UCP-123-456-789.pkg.Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Package&targetId=inst.UCP-123-456-789.pkg.Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Package&targetId=inst.UCP-123-456-789.pkg.Hitachi_bootbank_scsi-hfcldd_4.28.16.1156-1OEM.500.0.0.472560&relation=self%7Csubcomponent"}],"AcceptanceLevel": "VMwareCertified","Description": "ESX Driver","Name": "scsi-hfcldd","ReleaseDate": "\/Date(1329469024503)\/","StatelessReady": true,"Summary": "hfcldd: scsi driver for VMware ESX","Vendor": "Hitachi","Version": "4.28.16.1156-1OEM.500.0.0.472560"},]
Get image repository locations
This HTTP request uses the GET method on the /api/repository/locationsURI. Repository locations are added by the user and contain ESXi images.Other image types, such as Windows or Linux are deployed by WDS and arenot located in user-defined UCP repositories.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body contains the following properties.
Name Type Notes
RepositoryUrl StringThe location of the image repository. Ifmultiple repositories exist, they will bedisplayed as a comma separated list.
Chapter 2: UCP Director resources 365UCP Director API Reference
ESXi image and repository resources
Example: Get image repository locations
Request HeaderGET https://ucpmanagement.ucp.local/api/repository/locations HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"RepositoryUrl": "\\\\10.21.47.166\\Images"}]
Modify image repository locations
This HTTP request uses the PUT method on the /api/repository/locationsURI.
The payload in this request body replaces any existing repositories. To keepexisting repositories while adding a new one requires listing all of themtogether in the body of this request. Network share locations are supported,but online repositories are not supported at this time.
In vCenter, the UCP Server Administrator privilege is required.
The request body consists of the following property and value.
Name Type Notes
RepositoryUrl StringSpecifies the location of the imagerepository. Required format: “\\\\<IP-or-FQDN>\\shareName”
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
366 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
Example: Modify image repository locations
Request HeaderPUT https://ucpmanagement.ucp.local/api/repository/locations HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body[{"RepositoryUrl": "\\\\10.21.24.243\\RepositoryB"}]
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Change image repository".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get active image update notification recipients
This HTTP request uses the GET method on the/api/repository/updatenotifications URI.
This list of recipients will receive email when UCP creates an updatedversion of an active ESXi image. The platform manager must be configuredwith your company email server.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body contains a list of email addresses.
Name Type Notes
(Common properties) See Common properties.
EmailAddressList StringList of email addresses that are to receivenotification when images are updated.
Example: Get active image update notification recipients
Request HeaderGET https://ucpmanagement.ucp.local/api/repository/updatenotificationsHTTP/1.1 Content-Type: application/json; charset=utf-8
Chapter 2: UCP Director resources 367UCP Director API Reference
ESXi image and repository resources
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "0","ResourceType": "MailRecipientList","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.updnote","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/repository\/updatenotifications"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MailRecipientList&targetId=inst.UCP-123-456-789.cmp.1.img.updnote&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MailRecipientList&targetId=inst.UCP-123-456-789.cmp.1.img.updnote&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MailRecipientList&targetId=inst.UCP-123-456-789.cmp.1.img.updnote&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MailRecipientList&targetId=inst.UCP-123-456-789.cmp.1.img.updnote&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MailRecipientList&targetId=inst.UCP-123-456-789.cmp.1.img.updnote&relation=subcomponent"},
368 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MailRecipientList&targetId=inst.UCP-123-456-789.cmp.1.img.updnote&relation=self%7Csubcomponent"}],"EmailAddressList": ["[email protected]","[email protected]"]}
Modify active image update notification recipients
This HTTP request uses the PUT method on the/api/repository/updatenotifications URI.
The entire list of email addresses must be supplied in a comma separatedlist.
In vCenter, the UCP Server Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
EmailAddressList StringSpecifies all of the email addresses that areto receive notification when image areupdated.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Modify active image update notification recipients
Request HeaderPUT https://ucpmanagement.ucp.local/api/repository/updatenotificationsHTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"EmailAddressList": ["[email protected]",
Chapter 2: UCP Director resources 369UCP Director API Reference
ESXi image and repository resources
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Set image update notification recipientaddress".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Refresh image inventory
This HTTP request uses the POST method on the/api/repository/images/refresh URI.
This applies only to ESXi images and is often used after a repository locationis added or removed. With this API, UCP will check all repositories for newand removed ESXi images and will update internal inventory records.
In vCenter, the UCP Server Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Refresh image inventory
Request HeaderPOST https://ucpmanagement.ucp.local/api/repository/images/refreshHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Refresh image inventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
370 Chapter 2: UCP Director resources
UCP Director API Reference
ESXi image and repository resources
Event resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List UCP events" below GET UCP View
"Get UCP event" onpage 384
GET /api/events/(filters) UCP View
"Purge UCP events" onpage 387
POSTUCP SystemAdministration
List UCP events
This HTTP request uses the GET method on the /api/events URI.
To narrow the search results, this URI can be appended with a number offiltering criteria, those being:
• severity={SEVERITY} – Severity of the event
• &targetType={TARGETTYPE} – Target resource type
• &targetId={TARGETID} – Target Id of a single resource
• &relation={RELATION} – Self or subcomponent or both
• &eventType={EVENTTYPE} – Event type
• &jobId={JOBID} – Job Id of the event
• &fromDateTime={FROMDATETIME} – Starting date and time
• &toDateTime={TODATETIME} – Ending date and time
• &marker={MARKER} – Id of the event
• &offset={OFFSET} – Number of events to skip
• &count={COUNT} – Quantity of events to return
In vCenter, the UCP View privilege is required.
Chapter 2: UCP Director resources 371UCP Director API Reference
Event resources
Request body
The body for this request must be empty.
Response body
When the request succeeds, the response body consists of an array ofevents. The properties of events are detailed under the heading "Get UCPevent" on page 384.
Example: List most recent 100 UCP events
Request HeaderGET https://ucpmanagement.ucp.local/api/events HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response BodyAll events are listed. To see an example of an event, look under the headingGet UCP event.
Example: Get UCP events associated with a job
In this example, filtering criteria is added to the URI. Only those eventsassociated with jobId 3595 are requested.
Request HeaderGET https://ucpmanagement.ucp.local/api/events?jobId=3595 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Events": [{"Id": "2567","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.2567","InstanceId": "UCP-123-456-789","Links": [{
372 Chapter 2: UCP Director resources
UCP Director API Reference
Event resources
"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/2567"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "job","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/3595"}],"Arguments": [
],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1386804736005)\/","OffsetMinutes": 0},"Description": "UCP has successfully updated the inventory for server.","EventId": "2567","EventType": "ServerInventoryRefreshSucceedInfoEvent","JobId": "3595","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-123-456-789.cmp.1","TargetType": "Compute"}],"Marker": 2584}
Example: Get page 1 of UCP events for an Ethernet switch
This filter returns the most recent five events associated with the specifiedEthernet switch.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/events?targetType=EthernetSwitch&targetId=inst.UCP-123-456-789.eth.1.net.1&count=5 HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{
Chapter 2: UCP Director resources 373UCP Director API Reference
Event resources
"Events": [{"Id": "2346","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.2346","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/2346"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1"}],"Arguments": [{"Key": "var1","Value": "10.21.62.214"},{"Key": "ifIndex","Value": "TenGigabitEthernet 0\/3"},{"Key": "ifAdminStatus","Value": "Up"},{"Key": "ifOperStatus","Value": "Up"}],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1386800140712)\/","OffsetMinutes": 0},"Description": "LinkUp event received from Ethernet switch 10.21.62.214on port TenGigabitEthernet 0\/3. The desired admin status for this portis Up and operational status is Up. There are no hosts connected to theport.","EventId": "2346","EventType": "EthernetSwitchLinkUPDisconnectedPortInfoEvent","JobId": null,"RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-123-456-789.eth.1.net.1",
374 Chapter 2: UCP Director resources
UCP Director API Reference
Event resources
"TargetType": "EthernetSwitch"},{"Id": "2345","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.2345","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/2345"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1"}],"Arguments": [{"Key": "var1","Value": "10.21.62.214"},{"Key": "ifIndex","Value": "TenGigabitEthernet 0\/1"},{"Key": "ifAdminStatus","Value": "Up"},{"Key": "ifOperStatus","Value": "Up"}],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1386800140131)\/","OffsetMinutes": 0},"Description": "LinkUp event received from Ethernet switch 10.21.62.214on port TenGigabitEthernet 0\/1. The desired admin status for this portis Up and operational status is Up. There are no hosts connected to theport.","EventId": "2345","EventType": "EthernetSwitchLinkUPDisconnectedPortInfoEvent","JobId": null,"RecommendedAction": null,"Severity": "info",
Chapter 2: UCP Director resources 375UCP Director API Reference
Event resources
"TargetId": "inst.UCP-123-456-789.eth.1.net.1","TargetType": "EthernetSwitch"},{"Id": "2344","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.2344","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/2344"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1"}],"Arguments": [{"Key": "var1","Value": "10.21.62.214"},{"Key": "ifIndex","Value": "TenGigabitEthernet 0\/2"},{"Key": "ifAdminStatus","Value": "Up"},{"Key": "ifOperStatus","Value": "Down"}],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1386800139500)\/","OffsetMinutes": 0},"Description": "LinkDown event received from Ethernet switch10.21.62.214 on port TenGigabitEthernet 0\/2. The desired admin statusfor this port is Up and operational status is Down. There are no hostsconnected to the port.","EventId": "2344","EventType": "EthernetSwitchLinkDownDisconnectedPortInfoEvent","JobId": null,"RecommendedAction": null,
376 Chapter 2: UCP Director resources
UCP Director API Reference
Event resources
"Severity": "info","TargetId": "inst.UCP-123-456-789.eth.1.net.1","TargetType": "EthernetSwitch"},{"Id": "2343","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.2343","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/2343"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1"}],"Arguments": [{"Key": "var1","Value": "10.21.62.214"},{"Key": "ifIndex","Value": "TenGigabitEthernet 0\/1"},{"Key": "ifAdminStatus","Value": "Up"},{"Key": "ifOperStatus","Value": "Down"}],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1386800138777)\/","OffsetMinutes": 0},"Description": "LinkDown event received from Ethernet switch10.21.62.214 on port TenGigabitEthernet 0\/1. The desired admin statusfor this port is Up and operational status is Down. There are no hostsconnected to the port.","EventId": "2343","EventType": "EthernetSwitchLinkDownDisconnectedPortInfoEvent","JobId": null,
Chapter 2: UCP Director resources 377UCP Director API Reference
Event resources
"RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-123-456-789.eth.1.net.1","TargetType": "EthernetSwitch"},{"Id": "2342","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.2342","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/2342"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/ethernetswitches\/1"}],"Arguments": [{"Key": "var1","Value": "10.21.62.214"},{"Key": "ifIndex","Value": "TenGigabitEthernet 0\/3"},{"Key": "ifAdminStatus","Value": "Up"},{"Key": "ifOperStatus","Value": "Down"}],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1386800138187)\/","OffsetMinutes": 0},"Description": "LinkDown event received from Ethernet switch10.21.62.214 on port TenGigabitEthernet 0\/3. The desired admin statusfor this port is Up and operational status is Down. There are no hostsconnected to the port.","EventId": "2342","EventType": "EthernetSwitchLinkDownDisconnectedPortInfoEvent",
378 Chapter 2: UCP Director resources
UCP Director API Reference
Event resources
"JobId": null,"RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-123-456-789.eth.1.net.1","TargetType": "EthernetSwitch"}],"Marker": 2598}
Example: Get 3 events related to a specified server
In this example, events related to a specific server are requested. Theserver is identified by its global resource Id. A page of 3 events is requestedstarting with and working back from event 7390.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/events?targetType=Server&targetId=inst.UCP-123-456-789.cmp.1.ser.45f6c765-b37d-11e1-ac31-cba134fd5e3e&marker=7390&count=3 HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Events": [{"Id": "7390","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.7390","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/7390"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "job","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/3000"},{"Rel": "target",
Chapter 2: UCP Director resources 379UCP Director API Reference
Event resources
"Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/45f6c765-b37d-11e1-ac31-cba134fd5e3e"}],"Arguments": [{"Key": "imageName","Value": ""}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386803815021)\/","OffsetMinutes": 0},"Description": "Auto deploy did not load the expected image: .","EventId": "7390","EventType": "ServerAutoDeployDidNotLoadCorrectImageErrorEvent","JobId": "3000","RecommendedAction": null,"Severity": "error","TargetId": "inst.UCP-123-456-789.cmp.1.ser.45f6c765-b37d-11e1-ac31-cba134fd5e3e","TargetType": "Server"},{"Id": "7298","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.7298","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/7298"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "job","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/3000"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/45f6c765-b37d-11e1-ac31-cba134fd5e3e"}],"Arguments": [{"Key": "serverSerialNumber","Value": "323GGAGC0A1-TNNX14Y00000004"
380 Chapter 2: UCP Director resources
UCP Director API Reference
Event resources
},{"Key": "serverUuid","Value": "45f6c765-b37d-11e1-ac31-cba134fd5e3e"}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386803153710)\/","OffsetMinutes": 0},"Description": "UCP has reset server with serial number: 323GGAGC0A1-TNNX14Y00000004 (UUID = 45f6c765-b37d-11e1-ac31-cba134fd5e3e). Autodeploy will now load ESXi. This could take a few minutes.","EventId": "7298","EventType": "ImageDeployRebootDoneInfoEvent","JobId": "3000","RecommendedAction": "Please access console via the Servers table toview progress.","Severity": "info","TargetId": "inst.UCP-123-456-789.cmp.1.ser.45f6c765-b37d-11e1-ac31-cba134fd5e3e","TargetType": "Server"},{"Id": "7297","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.7297","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/7297"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "job","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/3000"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/45f6c765-b37d-11e1-ac31-cba134fd5e3e"}],"Arguments": [{"Key": "serverUuid","Value": "45f6c765-b37d-11e1-ac31-cba134fd5e3e"
Chapter 2: UCP Director resources 381UCP Director API Reference
Event resources
},{"Key": "serverSerialNumber","Value": "323GGAGC0A1-TNNX14Y00000004"},{"Key": "hcsmPowerStateChangeResult","Value": "Completed"}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386803153459)\/","OffsetMinutes": 0},"Description": "Succeeded in changing the power state of server Id:45f6c765-b37d-11e1-ac31-cba134fd5e3e with serial number: 323GGAGC0A1-TNNX14Y00000004. HCSM status: Completed.","EventId": "7297","EventType": "ServerUcpPowerStateChangeSuccessInfoEvent","JobId": "3000","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-123-456-789.cmp.1.ser.45f6c765-b37d-11e1-ac31-cba134fd5e3e","TargetType": "Server"}],"Marker": 7390}
Example: Get a page of 50 events, skipping first 100
Request HeaderGEThttps://ucpmanagement.ucp.local/api/events?targetType=Server&targetId=inst.UCP-123-456-789.cmp.1.ser.45f6c765-b37d-11e1-ac31-cba134fd5e3e&marker=7390&count=3 HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Events": [{"Id": "7440","ResourceType": "Event","GlobalResourceId": "inst.v2ProductionE-123-456-789.event.7440",
382 Chapter 2: UCP Director resources
UCP Director API Reference
Event resources
"InstanceId": "v2ProductionE-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/7440"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "job","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/5129"}],"Arguments": [
],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1386807614565)\/","OffsetMinutes": 0},"Description": "UCP has successfully updated the inventory for server.","EventId": "7440","EventType": "ServerInventoryRefreshSucceedInfoEvent","JobId": "5129","RecommendedAction": null,"Severity": "info","TargetId": "inst.v2ProductionE-123-456-789.cmp.1","TargetType": "Compute"},{"Id": "7439","ResourceType": "Event","GlobalResourceId": "inst.v2ProductionE-123-456-789.event.7439","InstanceId": "v2ProductionE-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/7439"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "job","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/5122"}],"Arguments": [
Chapter 2: UCP Director resources 383UCP Director API Reference
Event resources
],"CreatedBy": "ucp\\vahid","CreatedTime": {"DateTime": "\/Date(1386807508685)\/","OffsetMinutes": 0},"Description": "UCP has updated inventory details for storage resourcesthat are connected to host(s).","EventId": "7439","EventType": "StoragePlatformInventoryRefreshSucceedInfoEvent","JobId": "5122","RecommendedAction": null,"Severity": "info","TargetId": "inst.v2ProductionE-123-456-789.stor.1","TargetType": "Storage"}
Get UCP event
This HTTP request uses the GET method on the /api/events/{EVENTID}URI, where {EVENTID} specifies the ID of the UCP event that is to bereturned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
Name Type Notes
(Common properties) See Common properties.
Arguments CollectionA collection of Key and Value pairs for theevent arguments.
Key StringKey value of the EventType for theDescription message.
Value StringValue to be substituted in for the Key inthe Description message.
CreatedBy String The user who initiated the event.
CreatedTime CollectionCollection of the following two timingmetrics.
DateTime DateTimeTime stamp for the beginning of theevent.
384 Chapter 2: UCP Director resources
UCP Director API Reference
Event resources
Name Type Notes
OffsetMinutes Int32 Offset from UTC time
Description String The description of the event.
EventId String Identifies the UCP event.
EventType StringThe type of UCP event. Use this value withthe {EVENTTYPE} query parameter tofind other events of the same type.
JobId String
Identifies the job associated with theevent. Use with the {JOBID} queryparameter to find other events from thesame job.
RecommendedAction StringThe recommended action from UCP, ifany.
Severity String
The severity level of the event. Values:
• Info
• Warning
• Error
TargetId StringThe ID of the resource targeted by theevent.
TargetType String
The type of target associated with theevent. See the list of TargetType valuesunder the heading List UCP jobs by filteredcriteria.
Example: Get a UCP event by its Id
Request HeaderGET https://ucpmanagement.ucp.local/api/events/2506 HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "2506","ResourceType": "Event","GlobalResourceId": "inst.UCP-123-456-789.event.2506","InstanceId": "UCP-123-456-789","Links": [{
Chapter 2: UCP Director resources 385UCP Director API Reference
Event resources
"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events\/2506"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events"},{"Rel": "job","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/3552"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics\/1"}],"Arguments": [{"Key": "ZoneName","Value": "Port0_03061b51_b391_11e1_8062_b3cf1df7d7fc_CL7H_VSP_10_20_90_66,Port0_03061b51_b391_11e1_8062_b3cf1df7d7fc_CL8H_VSP_10_20_90_66,Port1_03061b51_b391_11e1_8062_b3cf1df7d7fc_CL7H_VSP_10_20_90_66,Port1_03061b51_b391_11e1_8062_b3cf1df7d7fc_CL8H_VSP_10_20_90_66"},{"Key": "FabricName","Value": "Fabric B"}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386804018105)\/","OffsetMinutes": 0},"Description": "Removed Fibre Channel zone(s): Port0_03061b51_b391_11e1_8062_b3cf1df7d7fc_CL7H_VSP_10_20_90_66,Port0_03061b51_b391_11e1_8062_b3cf1df7d7fc_CL8H_VSP_10_20_90_66,Port1_03061b51_b391_11e1_8062_b3cf1df7d7fc_CL7H_VSP_10_20_90_66,Port1_03061b51_b391_11e1_8062_b3cf1df7d7fc_CL8H_VSP_10_20_90_66 from the active zoneset in fabric(s):Fabric B.","EventId": "2506","EventType": "ZoneRemoveForFabricInfoEvent","JobId": "3552","RecommendedAction": null,"Severity": "error","TargetId": "inst.UCP-123-456-789.fc.1.fab.1","TargetType": "StorageFabric"}
386 Chapter 2: UCP Director resources
UCP Director API Reference
Event resources
Purge UCP events
This HTTP request uses the POST method on the /api/events/purge URI.
The UCP System Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Purge UCP events
Request HeaderPOST https://ucpmanagement.ucp.local/api/events/purge HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Purge UCP Events according to retentionpolicy".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Fibre Channel fabric resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List Fibre Channelfabrics" on the next page
GET /api/fibrechannelfabrics UCP View
"Get Fibre Channel fabric"on page 389
GET/api/fibrechannelfabrics/{FABRICID}
UCP View
Chapter 2: UCP Director resources 387UCP Director API Reference
Fibre Channel fabric resources
Request Method URIvCenterPrivilege
"List zones in a FibreChannel fabric" onpage 392
GET/api/fibrechannelfabrics/{FABRICID}/zones
UCP View
"Get zone in a FibreChannel fabric" onpage 397
GET/api/fibrechannelfabrics/{FABRICID}/zones/{ZONEID}
UCP View
"Create zone in a FibreChannel fabric" onpage 399
POST/api/fibrechannelfabrics/{FABRICID}/zones
UCP StorageAdministrator
"Modify zone in a FibreChannel fabric" onpage 400
PUT/api/fibrechannelfabrics/{FABRICID}/zones/{ZONEID}
UCP StorageAdministrator
"Remove zone from aFibre Channel fabric" onpage 401
DELETE/api/fibrechannelfabrics/{FABRICID}/zones/{ZONEID}
UCP StorageAdministrator
List Fibre Channel fabrics
This HTTP request uses the GET method on the /api/fibrechannelfabricsURI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body contains the fibre channelfabrics. See "Get Fibre Channel fabric" on the facing page for details.
Example: List all fabrics
Request HeaderGET https://ucpmanagement.ucp.local/api/fibrechannelfabrics HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response BodyBoth Fibre Channel fabrics are listed. For an example of a Fibre Channelfabric, see the heading "Get Fibre Channel fabric" on the facing page.
388 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel fabric resources
Get Fibre Channel fabric
This HTTP request uses the GET method on the /api/fibrechannelfabrics/{FABRICID} URI, where {FABRICID} specifies the ID of the fabric that is tobe returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
Name Type Notes
ActiveZonesetName String The name of active zoneset for the fabric.
FabricName String The name of the fabric.
FcPortsArray ofObjects
The Fibre Channel ports in the fabric.
StringThe name of device connected to FibreChannel port.
String
The type of the Fibre Channel port. Values:
• Initiator
• Target
• Unknown
String The alias of the Fibre Channel port.
String The name of the Fibre Channel port.
Example: Get a fabric
Request HeaderGET https://ucpmanagement.ucp.local/api/fibrechannelfabrics/1 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{
Chapter 2: UCP Director resources 389UCP Director API Reference
Fibre Channel fabric resources
"Id": "1","ResourceType": "StorageFabric","GlobalResourceId": "inst.UCP-12345.fc.1.fab.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageFabric&targetId=inst.UCP-12345.fc.1.fab.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageFabric&targetId=inst.UCP-12345.fc.1.fab.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageFabric&targetId=inst.UCP-12345.fc.1.fab.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageFabric&targetId=inst.UCP-12345.fc.1.fab.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageFabric&targetId=inst.UCP-12345.fc.1.fab.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageFabric&targetId=inst.UCP-12345.fc.1.fab.1&relation=self%7Csubcomponent"}],"ActiveZonesetName": "UCP_Compute_Config_B","FabricName": "Fabric B",
390 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel fabric resources
"FcPorts": [{"DeviceName": "5efc472f-06c1-11e2-a75f-9dd657453cae","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.0A"},{"DeviceName": "946eb8d3-0934-11e2-8b82-9d48fc508733","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.1A"},{"DeviceName": "65d1fc27-0917-11e2-bafc-f267d6c84076","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.4A"},{"DeviceName": "68a1589f-eaa0-11e1-b140-9205f7796bd2","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.5A"},{"DeviceName": "db97308f-04b0-11e2-97d3-f5ff9d4be080","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.8A"},{"DeviceName": "0db13cea-ea9b-11e1-a73a-f85ad620e32d","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.9A"},{"DeviceName": "7b60677e-eb48-11e1-bcff-f78db160ca9c","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.CA"},{"DeviceName": "a8730650-0919-11e2-baa2-d0c6dceef8b7","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.DA"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL7-A",
Chapter 2: UCP Director resources 391UCP Director API Reference
Fibre Channel fabric resources
"PortName": "50.06.0E.80.13.27.27.60"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL8-A","PortName": "50.06.0E.80.13.27.27.70"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL7-B","PortName": "50.06.0E.80.13.27.27.61"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL6-B","PortName": "50.06.0E.80.13.27.27.51"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL5-B","PortName": "50.06.0E.80.13.27.27.41"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL8-B","PortName": "50.06.0E.80.13.27.27.71"}}
List zones in a Fibre Channel fabric
This HTTP request uses the GET method on the /api/fibrechannelfabrics/{FABRICID}/zones URI, where {FABRICID} specifies the ID of the fabricwith the zones that are to be returned.
In vCenter, the UCP View privilege is required.
Optional filter criteria at the end of the URI can narrow the list of zones toonly those used by a specific server.
Fiter criteria:
?server={ServerId}
Request body
392 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel fabric resources
The body for this request must be empty.
Response body
The response body contains all zones in the specified Fibre Channel fabric.Details regarding zones are shown under the heading "Get zone in a FibreChannel fabric" on page 397.
Example: List all zones in a fabric
Request HeaderGET https://ucpmanagement.ucp.local/api/fibrechannelfabrics/2/zonesHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response BodyAll zones in the specified fabric are listed. For an example of zone details,see Example: Get a zone in a fabric.
Example: List all zones in a fabric that are used by a server
In this example, the server Id is used as a filter criteria in the URI. Theresponse contains all zones used by that server in the specified fabric. Forthe sake of brevity, just two zones are listed here.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/fibrechannelfabrics/1/zones?server=6e37f410-b4a7-11e1-94b0-c6aca3093fbb HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252","ResourceType": "StorageZone","GlobalResourceId": "inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252","InstanceId": "UCP-12345","Links": [
Chapter 2: UCP Director resources 393UCP Director API Reference
Fibre Channel fabric resources
{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics\/1\/zones\/Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics\/1\/zones"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252&relation=subcomponent"},{"Rel": "events.all",
394 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel fabric resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252&relation=self%7Csubcomponent"}],"FabricId": "1","Name": "Port1_r1_hi_cb500_1_b03_ucp_local_CL7A_HUS_VM_10_21_57_252","PortMembers": [{"DeviceName": "68a1589f-eaa0-11e1-b140-9205f7796bd2","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.5A"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL7-A","PortName": "50.06.0E.80.13.27.27.60"}]},{"Id": "Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252","ResourceType": "StorageZone","GlobalResourceId": "inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics\/1\/zones\/Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics\/1\/zones"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252&relation=self"},{"Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 395UCP Director API Reference
Fibre Channel fabric resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252&relation=self%7Csubcomponent"}],"FabricId": "1","Name": "Port1_r1_hi_cb500_1_b03_ucp_local_CL8A_HUS_VM_10_21_57_252","PortMembers": [{"DeviceName": "68a1589f-eaa0-11e1-b140-9205f7796bd2","FcPortType": "Initiator","PortAlias": "Port1","PortName": "24.00.D0.5F.CE.01.01.5A"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL8-A","PortName": "50.06.0E.80.13.27.27.70"}]}]
396 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel fabric resources
Get zone in a Fibre Channel fabric
This HTTP request uses the GET method on the /api/fibrechannelfabrics/{FABRICID}/zones/{ZONEID} URI, where {FABRICID} specifies the ID ofthe fabric with the zone that is to be returned and {ZONEID} is the ID ofthat zone.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of an array of theproperties detailed in the following table.
Name Type Notes
FabricId String The ID of the fabric.
Name String The name of the zone.
PortMembersArray ofObjects
The port members of the zone.
StringThe name of the device connected to theFibre Channel port.
String
The type of the Fibre Channel port. Values:
• Initiator
• Target
• Unknown
String The alias of the Fibre Channel port.
String The name of the Fibre Channel port.
Example: Get a zone in a fabric
In this example, the zone is specified by Id in the URI as is the fabricnumber.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/fibrechannelfabrics/1/zones/Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_ HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Chapter 2: UCP Director resources 397UCP Director API Reference
Fibre Channel fabric resources
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_","ResourceType": "StorageZone","GlobalResourceId": "inst.UCP-12345.fc.1.fab.1.zone.Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics\/1\/zones\/Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelfabrics\/1\/zones"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_&relation=self"},{
398 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel fabric resources
"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageZone&targetId=inst.UCP-12345.fc.1.fab.1.zone.Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_&relation=self%7Csubcomponent"}],"FabricId": "1","Name": "Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_","PortMembers": [{"DeviceName": "7b60677e-eb48-11e1-bcff-f78db160ca9c","FcPortType": "Initiator","PortAlias": "Port0","PortName": "24.00.D0.5F.CE.01.01.C8"},{"DeviceName": "HUS [email protected]","FcPortType": "Target","PortAlias": "CL8-B","PortName": "50.06.0E.80.13.27.27.71"}}
Create zone in a Fibre Channel fabric
This HTTP request uses the POST method on the /api/fibrechannelfabrics/{FABRICID}/zones URI, where {FABRICID} specifies the ID of the fabricwhere the zone is to be created.
In vCenter, the UCP Storage Administrator privilege is required
The request body consists of the following properties.
Name Type Notes
Initiator String Specifies the initiator's WWN for the zone.
Chapter 2: UCP Director resources 399UCP Director API Reference
Fibre Channel fabric resources
Name Type Notes
Name String
Specifies the name of the zone to becreated. Maximum length: 63 characters.Must begin with characters which may befollowed by numbers and underscores
Target String Specifies the target's WWN for the zone.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Create a new zone in a fabricRequest HeaderPOST https://ucpmanagement.ucp.local/api/fibrechannelfabrics/2/zonesHTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body[{"Initiator": "50.00.08.70.00.53.79.F0","Name": "ExampleZone","Target": "50.06.0E.80.06.CF.72.02"}]
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Create a zone on a Fibre Channelswitch".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Modify zone in a Fibre Channel fabric
This HTTP request uses the PUT method on the /api/fibrechannelfabrics/{FABRICID}/zones/{ZONEID} URI, where {FABRICID} specifies the ID ofthe fabric with the zone that is to be modified and {ZONEID} specifies theID of that zone.
Zones are modified to add newWWPNs from servers (Initiator) and SANports (Target).
In vCenter, the UCP Storage Administrator privilege is required
400 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel fabric resources
This request body consists of the following properties.
Name Type Notes
Initiator String Specifies the initiator's WWN for the zone.
Target String Specifies the target's WWN for the zone.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Modify the WWNs in a zone
In this example, the WWPN of the server side and of the SAN side are addedto an existing zone.
Request HeaderPUThttps://ucpmanagement.ucp.local/api/fibrechannelfabrics/1/zones/Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_ HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"Initiator": "50.00.08.70.00.53.79.F0","Target": "50.06.0E.80.06.CF.72.12"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update a zone on a Fibre Channelswitch".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Remove zone from a Fibre Channel fabric
This HTTP request uses the DELETE method on the/api/fibrechannelfabrics/{FABRICID}/zones/{ZONEID} URI, where{FABRICID} specifies the ID of the fabric with the zone that is to beremoved and {ZONEID} specifies the ID of that zone.
In vCenter, the UCP Storage Administrator privilege is required
Chapter 2: UCP Director resources 401UCP Director API Reference
Fibre Channel fabric resources
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Remove a zone from a fabric
Request HeaderDELETEhttps://ucpmanagement.ucp.local/api/fibrechannelfabrics/1/zones/Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL8B_HUS_VM_10_21_57_ HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Delete a zone on a Fibre Channelswitch".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Fibre Channel switch resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List Fibre Channelswitches" on thefacing page
GET /api/fibrechannelswitches UCP View
"Get Fibre Channelswitch" on page 404
GET /api/fibrechannelswitches/{SWITCHID} UCP View
"Add Fibre Channelswitch" on page 431
POST /api/fibrechannelswitchesUCP StorageAdministrator
"Remove FibreChannel switch" onpage 432
DELETE /api/fibrechannelswitches/{SWITCHID}UCP StorageAdministrator
402 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
Request Method URIvCenterPrivilege
"Get Fibre Channelswitch connectioninformation" onpage 433
GET/api/fibrechannelswitches/{SWITCHID}/connectioninformation
UCP View
"Modify Fibre Channelswitch connectioninformation" onpage 434
PUT/api/fibrechannelswitches/{SWITCHID}/connectioninformation
UCP StorageAdministrator
"Refresh FibreChannel switchinventory" onpage 435
POST /api/fibrechannelswitches/firmwareupdatesUCP StorageAdministrator
"Update firmware onFibre Channelswitches" onpage 435
POST/api/fibrechannelswitches/{SWITCHID}/firmwareupdates
UCP StorageAdministrator
"Update firmware onone Fibre Channelswitch" on page 436
POST /api/fibrechannelswitches/refreshUCP StorageAdministrator
List Fibre Channel switches
This HTTP request uses the GET method on the /api/fibrechannelswitchesURI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body lists all Fibre Channel switches in UCP inventory, eachdisplaying the properties described under the heading "Get Fibre Channelswitch" on the next page.
Example: List all Fibre Channel switches
Request HeaderGET https://ucpmanagement.ucp.local/api/fibrechannelswitches HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Chapter 2: UCP Director resources 403UCP Director API Reference
Fibre Channel switch resources
Response HeaderHTTP/1.1 200 OK
Response BodyAll Fibre Channel switches in UCP inventory are returned. For details, seethe example under Get Fibre Channel switch.
Get Fibre Channel switch
This HTTP request uses the GET method on the /api/fibrechannelswitches/{SWITCHID} URI, where {SWITCHID} specifies the ID of the FibreChannel switch that is to be returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body for Fibre Channel switches contains these properties perswitch.
Name Type Notes
(Common properties) See Common properties.
MonitorState Collection Collection of monitor state information.
GlobalResourceId String Globally unique Id of the switch.
MonitorIndicators CollectionCollection of the followingmonitorindicators.
DisplayName String Display name for the monitor indicator.
IndicatorState String State of indicator
IndicatorType String Type of indicator.
Name String Name of the indicator.
SubGlobalResourceIds String
Global Ids of subresources. When themonitor indicator is “Ports”, this sectionwill be populated with a comma delimitedlist of Ethernet switch port global Ids.
SubResourceType String
Type of the sub resource, if any. When themonitor indicator is “Ports”, theSubResourceType will be“EthernetSwitchPort”.
MonitorMode StringThe mode of reporting SNMP traps.Monitor, Report or Off.
404 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
Name Type Notes
NumErrors Int32Number of errors totaled fromSubGlobalResourceIds.
NumNotApplicables Int32Number of NAmessages totaled fromSubGlobalResourceIds.
NumOks Int32Number of OKmessages totaled fromSubGlobalResourceIds.
NumUnknowns Int32Number of Unknown messages totaledfrom SubGlobalResourceIds.
NumWarnings Int32Number of Warnings totaled fromSubGlobalResourceIds.
ResourceState StringMonitor state of the Fibre Channel switch,comprised of the aggregated state ofsubresources.
ResourceType StringResource type. Always“FibreChannelSwitch” for Fibre Channelswitches.
UpdatedDateTime DateTimeDate and time of the last Monitor stateaggregation.
AvailableFirmwareVersion StringIf UCP has another firmware bundle forthis switch, it is shown here.
FabricId StringId of the fabric in which this switchparticipates.
FirmwareVersion String Version of switch firmware.
Manufacturer String Manufacturer of the switch.
Model String Model of the switch.
Name String The name of the switch.
SerialNumber String The serial number of the switch.
Status String
The status of the switch. Values:
• Initializing
• Active
• Unreachable
• Unsupported
• Inconsistent
SwitchIpAddress String The management IP address of the switch.
Chapter 2: UCP Director resources 405UCP Director API Reference
Fibre Channel switch resources
Name Type Notes
SwitchPorts CollectionCollection of ports on the switch, eachhaving the following properties.
ResourceType StringAlways “FibreChannelSwitchPort” forports.
(Common properties) See Common properties.
MonitorState CollectionCollection of the samemonitor stateproperties as for the switch, but these arerepeated for each port as well.
ConnectedDeviceName StringThe name of the device connected to theswitch port.
ConnectedPortAlias StringThe alias of the port connected to theswitch port.
IsConneced StringWhether another device is connected tothe port.
LoginWWN StringThe world-wide name of the deviceconnected to the switch port.
PortName String Name of the port.
PortNumber String Port number.
PortState String
State of the port. Values are: Online,Offline, Testing, No_Card, No_Module, No_Light, No_SigDet, Mod_Inv, No_Sync, In_Sync, Laser_Flt, Port_Flt, Diag_Flt, Lock_Ref
PortStatus String
Status or usage of the port. Values are:Copper or Optical, Disabled, Bypassed,Loopback, D_Port, E_Port, F_Port, G_Port,L_Port, EX_Port, VF_Port, VF_PortDisabled, Mirror Port, (Trunk master),(Trunk port, master is port #x),(upstream), (downstream), FICONPersistent DID, Fabric ID conflict, Fabric IDoversubscribed, AoQ, LBmode, (logical),segmented
SwitchTopologyRole String
The role of the switch in the topology.Values:
• Core Switch
• Edge Switch
SwitchWwn String WWN ID for switch
Username StringThe username that UCP uses for managingthe switch.
406 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
Example: Get a Fibre Channel switch
Request HeaderGET https://ucpmanagement.ucp.local/api/fibrechannelswitches/2 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "2","ResourceType": "FibreChannelSwitch","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelswitches\/2"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/fibrechannelswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=FibreChannelSwitch&targetId=inst.UCP-12345.fc.1.fcs.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=FibreChannelSwitch&targetId=inst.UCP-12345.fc.1.fcs.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=FibreChannelSwitch&targetId=inst.UCP-12345.fc.1.fcs.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=FibreChannelSwitch&targetId=inst.UCP-12345.fc.1.fcs.2&relation=self"
Chapter 2: UCP Director resources 407UCP Director API Reference
Fibre Channel switch resources
},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=FibreChannelSwitch&targetId=inst.UCP-12345.fc.1.fcs.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=FibreChannelSwitch&targetId=inst.UCP-12345.fc.1.fcs.2&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2","MonitorIndicators": [{"DisplayName": "Temperature","IndicatorState": "Ok","IndicatorType": "Health","Name": "Temperature","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Ports","IndicatorState": "Ok","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.UCP-12345.fc.1.fcs.2.port.18","inst.UCP-12345.fc.1.fcs.2.port.19","inst.UCP-12345.fc.1.fcs.2.port.16","inst.UCP-12345.fc.1.fcs.2.port.17","inst.UCP-12345.fc.1.fcs.2.port.14","inst.UCP-12345.fc.1.fcs.2.port.15","inst.UCP-12345.fc.1.fcs.2.port.12","inst.UCP-12345.fc.1.fcs.2.port.6","inst.UCP-12345.fc.1.fcs.2.port.13","inst.UCP-12345.fc.1.fcs.2.port.10","inst.UCP-12345.fc.1.fcs.2.port.11","inst.UCP-12345.fc.1.fcs.2.port.4","inst.UCP-12345.fc.1.fcs.2.port.3","inst.UCP-12345.fc.1.fcs.2.port.1","inst.UCP-12345.fc.1.fcs.2.port.24","inst.UCP-12345.fc.1.fcs.2.port.25","inst.UCP-12345.fc.1.fcs.2.port.22","inst.UCP-12345.fc.1.fcs.2.port.8","inst.UCP-12345.fc.1.fcs.2.port.23","inst.UCP-12345.fc.1.fcs.2.port.20","inst.UCP-12345.fc.1.fcs.2.port.21","inst.UCP-12345.fc.1.fcs.2.port.7",
408 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"inst.UCP-12345.fc.1.fcs.2.port.5","inst.UCP-12345.fc.1.fcs.2.port.9","inst.UCP-12345.fc.1.fcs.2.port.2","inst.UCP-12345.fc.1.fcs.2.port.0"],"SubResourceType": "FibreChannelSwitchPort"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 10,"NumOks": 11,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitch","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"AvailableFirmwareVersion": null,"FabricId": "1","FirmwareVersion": "v7.0.2c","Manufacturer": "Brocade","Model": "Brocade 5460","Name": "R1-HI-CB500-1-U03-5460B","SerialNumber": "AUM0414H008","Status": "Active","SwitchIpAddress": "10.21.57.179","SwitchPorts": [{"Id": "0","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.0","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.0","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],
Chapter 2: UCP Director resources 409UCP Director API Reference
Fibre Channel switch resources
"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"ConnectedDeviceName": "R1-BR-6510-B-U37","ConnectedPortAlias": "","IsConnected": true,"LoginWWN": "10:00:00:05:33:D1:5A:45","PortName": "0","PortNumber": "0","PortState": "Online","PortStatus": "E-Port"},{"Id": "1","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.1","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.1","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"
410 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
},"ConnectedDeviceName": "R1-BR-6510-B-U37","ConnectedPortAlias": "","IsConnected": true,"LoginWWN": "10:00:00:05:33:D1:5A:45","PortName": "1","PortNumber": "1","PortState": "Online","PortStatus": "E-Port"},{"Id": "2","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.2","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.2","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"ConnectedDeviceName": "R1-BR-6510-B-U37","ConnectedPortAlias": "","IsConnected": true,"LoginWWN": "10:00:00:05:33:D1:5A:45","PortName": "2","PortNumber": "2","PortState": "Online","PortStatus": "E-Port"
Chapter 2: UCP Director resources 411UCP Director API Reference
Fibre Channel switch resources
},{"Id": "3","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.3","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.3","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"ConnectedDeviceName": "R1-BR-6510-B-U37","ConnectedPortAlias": "","IsConnected": true,"LoginWWN": "10:00:00:05:33:D1:5A:45","PortName": "3","PortNumber": "3","PortState": "Online","PortStatus": "E-Port"},{"Id": "4","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.4","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.4","MonitorIndicators": [
412 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "4","PortNumber": "4","PortState": "No_Module","PortStatus": ""},{"Id": "5","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.5","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.5","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{
Chapter 2: UCP Director resources 413UCP Director API Reference
Fibre Channel switch resources
"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "5","PortNumber": "5","PortState": "No_Module","PortStatus": ""},{"Id": "6","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.6","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.6","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off",
414 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "5efc472f-06c1-11e2-a75f-9dd657453cae","ConnectedPortAlias": "Port1","IsConnected": true,"LoginWWN": "24:00:D0:5F:CE:01:01:0A","PortName": "6","PortNumber": "6","PortState": "Online","PortStatus": "F-Port"},{"Id": "7","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.7","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.7","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},
Chapter 2: UCP Director resources 415UCP Director API Reference
Fibre Channel switch resources
"ConnectedDeviceName": "946eb8d3-0934-11e2-8b82-9d48fc508733","ConnectedPortAlias": "Port1","IsConnected": true,"LoginWWN": "24:00:D0:5F:CE:01:01:1A","PortName": "7","PortNumber": "7","PortState": "Online","PortStatus": "F-Port"},{"Id": "8","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.8","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.8","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"ConnectedDeviceName": "65d1fc27-0917-11e2-bafc-f267d6c84076","ConnectedPortAlias": "Port1","IsConnected": true,"LoginWWN": "24:00:D0:5F:CE:01:01:4A","PortName": "8","PortNumber": "8","PortState": "Online","PortStatus": "F-Port"},
416 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
{"Id": "9","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.9","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.9","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "68a1589f-eaa0-11e1-b140-9205f7796bd2","ConnectedPortAlias": "Port1","IsConnected": true,"LoginWWN": "24:00:D0:5F:CE:01:01:5A","PortName": "9","PortNumber": "9","PortState": "Online","PortStatus": "F-Port"},{"Id": "10","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.10","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.10","MonitorIndicators": [{
Chapter 2: UCP Director resources 417UCP Director API Reference
Fibre Channel switch resources
"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"ConnectedDeviceName": "db97308f-04b0-11e2-97d3-f5ff9d4be080","ConnectedPortAlias": "Port1","IsConnected": true,"LoginWWN": "24:00:D0:5F:CE:01:01:8A","PortName": "10","PortNumber": "10","PortState": "Online","PortStatus": "F-Port"},{"Id": "11","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.11","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.11","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance",
418 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"ConnectedDeviceName": "0db13cea-ea9b-11e1-a73a-f85ad620e32d","ConnectedPortAlias": "Port1","IsConnected": true,"LoginWWN": "24:00:D0:5F:CE:01:01:9A","PortName": "11","PortNumber": "11","PortState": "Online","PortStatus": "F-Port"},{"Id": "12","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.12","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.12","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,
Chapter 2: UCP Director resources 419UCP Director API Reference
Fibre Channel switch resources
"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"ConnectedDeviceName": "7b60677e-eb48-11e1-bcff-f78db160ca9c","ConnectedPortAlias": "Port1","IsConnected": true,"LoginWWN": "24:00:D0:5F:CE:01:01:CA","PortName": "12","PortNumber": "12","PortState": "Online","PortStatus": "F-Port"},{"Id": "13","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.13","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.13","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "12\/15\/2013 1:04:49 AM +00:00"},"ConnectedDeviceName": "a8730650-0919-11e2-baa2-d0c6dceef8b7",
420 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"ConnectedPortAlias": "Port1","IsConnected": true,"LoginWWN": "24:00:D0:5F:CE:01:01:DA","PortName": "13","PortNumber": "13","PortState": "Online","PortStatus": "F-Port"},{"Id": "14","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.14","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.14","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "14","PortNumber": "14","PortState": "No_Sync","PortStatus": "Disabled"},{
Chapter 2: UCP Director resources 421UCP Director API Reference
Fibre Channel switch resources
"Id": "15","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.15","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.15","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "15","PortNumber": "15","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "16","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.16","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.16","MonitorIndicators": [{"DisplayName": "Interface Health",
422 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "16","PortNumber": "16","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "17","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.17","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.17","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable",
Chapter 2: UCP Director resources 423UCP Director API Reference
Fibre Channel switch resources
"IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "17","PortNumber": "17","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "18","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.18","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.18","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,
424 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "18","PortNumber": "18","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "19","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.19","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.19","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "",
Chapter 2: UCP Director resources 425UCP Director API Reference
Fibre Channel switch resources
"IsConnected": false,"LoginWWN": "","PortName": "19","PortNumber": "19","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "20","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.20","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.20","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "20","PortNumber": "20","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "21",
426 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.21","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.21","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "21","PortNumber": "21","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "22","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.22","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.22","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable",
Chapter 2: UCP Director resources 427UCP Director API Reference
Fibre Channel switch resources
"IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "22","PortNumber": "22","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "23","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.23","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.23","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance",
428 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "23","PortNumber": "23","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "24","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.24","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.24","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,
Chapter 2: UCP Director resources 429UCP Director API Reference
Fibre Channel switch resources
"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,"LoginWWN": "","PortName": "24","PortNumber": "24","PortState": "No_Sync","PortStatus": "Disabled"},{"Id": "25","ResourceType": "FibreChannelSwitchPort","GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.25","InstanceId": "UCP-12345","MonitorState": {"GlobalResourceId": "inst.UCP-12345.fc.1.fcs.2.port.25","MonitorIndicators": [{"DisplayName": "Interface Health","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "InterfaceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Interface Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "InterfacePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Off","NumErrors": 0,"NumNotApplicables": 2,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "FibreChannelSwitchPort","UpdatedDateTime": "1\/1\/0001 12:00:00 AM +00:00"},"ConnectedDeviceName": "","ConnectedPortAlias": "","IsConnected": false,
430 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
"LoginWWN": "","PortName": "25","PortNumber": "25","PortState": "No_Sync","PortStatus": "Disabled"}],"SwitchTopologyRole": "Edge Switch","SwitchWwn": "10:00:00:05:33:D2:0F:9D","Username": "ucpadmin"}
Add Fibre Channel switch
This HTTP request uses the POST method on the /api/fibrechannelswitchesURI.
When a Fibre Channel switch is successfully added to inventory, its state isset to Initializing. Once inventory is successfully refreshed it becomesactive.
The UCP Storage Administrator privilege is required
This request body consists the following properties.
Name Type Notes
Password StringSpecifies the password to be used tomanage the Fibre Channel switch. Validlength: 0-40 characters.
SwitchIPAddress StringSpecifies the management IP address ofthe Fibre Channel switch that is to beadded to inventory.
Username String
Specifies the username for managing theFibre Channel switch. Valid length range:1-40 characters. Valid characters:alphanumeric, period and underscore.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Chapter 2: UCP Director resources 431UCP Director API Reference
Fibre Channel switch resources
Example: Add a Fibre Channel switch to inventory
Request HeaderPOST https://ucpmanagement.ucp.local/api/fibrechannelswitches HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body[{"Password": "Kum0@pur@1n$","SwitchIPAddress": "10.21.47.132","Username": "ucpadmin"}]
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Add Fibre Channel switch to inventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Remove Fibre Channel switch
This HTTP request uses the DELETE method on the/api/fibrechannelswitches/{SWITCHID} URI, where {SWITCHID} specifiesthe ID of the Fibre Channel switch that is to be removed from inventory.
In vCenter, the UCP Storage Administrator privilege is required
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Remove a Fibre Channel switch from inventory
Request HeaderDELETE https://ucpmanagement.ucp.local/api/fibrechannelswitches/4HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
432 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
Response BodyThe system executes a job named "Remove Fibre Channel switch frominventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get Fibre Channel switch connection information
This HTTP request uses the GET method on the /api/fibrechannelswitches/{SWITCHID}/connectioninformation URI, where {SWITCHID} specifies theID of the Fibre Channel switch with the connection information that is to bereturned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body will contain the following properties.
Name Type Notes
SwitchIpAddress String The management IP address of the switch.
Username String The username used tomanage the switch.
Example: Get connection information for a Fibre Channel switch
Request HeaderGEThttps://ucpmanagement.ucp.local/api/fibrechannelswitches/4/connectioninformation HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"SwitchIpAddress": "10.21.74.178","Username": "ucpadmin"}
Chapter 2: UCP Director resources 433UCP Director API Reference
Fibre Channel switch resources
Modify Fibre Channel switch connection information
This HTTP request uses the PUT method on the /api/fibrechannelswitches/{SWITCHID}/connectioninformation URI, where {SWITCHID} specifies theID of the Fibre Channel switch with the connection information that is to bemodified.
In vCenter, the UCP Storage Administrator privilege is required
This request body consists of the following properties.
Name Type Notes
Password StringSpecifies the new password that is to beused tomanage the Fibre Channel switch.Valid length: 0-40 characters.
SwitchIPAddress StringSpecifies the new management IP addressof the Fibre Channel switch.
Username String
Specifies the new username that is to beused tomanage the Fibre Channel switch.Valid length range: 1-40 characters. Validcharacters: alphanumeric, period andunderscore.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Modify the credentials used to manage a Fibre Channel switch
Request HeaderPUThttps://ucpmanagement.ucp.local/api/fibrechannelswitches/4/connectioninformation HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"Password": "Kum0@pur@1n$","SwitchIPAddress": "10.21.47.143","Username": "ucpadmin"}
Response HeaderHTTP/1.1 202 Accepted
434 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
Response BodyThe system executes a job named "Update Fibre Channel switch connectioninformation".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Refresh Fibre Channel switch inventory
This HTTP request uses the POST method on the/api/fibrechannelswitches/refresh URI.
In vCenter, the UCP Storage Administrator privilege is required
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Refresh Fibre Channel switch inventory
Request HeaderPOST https://ucpmanagement.ucp.local/api/fibrechannelswitches/refreshHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Refresh Fibre Channel switchesinventory".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Update firmware on Fibre Channel switches
This HTTP request uses the POST method on the/api/fibrechannelswitches/firmwareupdates API.
Chapter 2: UCP Director resources 435UCP Director API Reference
Fibre Channel switch resources
UCP will apply the pending firmware bundle onto all fibre channel switchesserially. The pending firmware bundle comes from UCP’s internal repository,having been placed there by the/updatemanagement/firmwareUpdatePackage API.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Update firmware on all Fibre Channel switches
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/fibrechannelswitches/firmwareupdatesHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update Fibre Channel switchesfirmware".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Update firmware on one Fibre Channel switch
This HTTP request uses the POST method on the /api/fibrechannelswitches/{SWITCHID}/firmwareupdates API.
Similar to “Update firmware on Fibre Channel switches”, this API appliesfirmware to the switch specified in the URI.
In vCenter, the UCP Storage Administrator privilege is required
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
436 Chapter 2: UCP Director resources
UCP Director API Reference
Fibre Channel switch resources
Example: Update firmware on specified Fibre Channel switch
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/fibrechannelswitches/2/firmwareupdates HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response Body{"Id": "5327","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.5327","InstanceId": "UCP-12345","links": [{"rel": "self","href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/5327"}],"CreatedBy": "UCP\\ucpadmin","EndTime": null,"Events": [{"Id": "3677","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.3677","InstanceId": "UCP-12345","Arguments": null,"CreatedTime": {"DateTime": "\/Date(1381181649900)\/","OffsetMinutes": 0},"Description": "Starting now, no configuration changing tasks will beallowed on UCP for the duration of the update.","EventId": "3677","EventType": "UCPEnterUpdateModeInfoEvent","JobId": "5327","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345","TargetType": "Instance","User": "UCP\\ucpadmin"},{"Id": "3678","ResourceType": "Event",
Chapter 2: UCP Director resources 437UCP Director API Reference
Fibre Channel switch resources
"GlobalResourceId": "inst.UCP-12345.event.3678","InstanceId": "UCP-12345","Arguments": null,"CreatedTime": {"DateTime": "\/Date(1381181650066)\/","OffsetMinutes": 0},"Description": "Firmware update started for Fibre Channel Switch with IPAddress: 10.21.84.171.","EventId": "3678","EventType": "FibreChannelSwitchFirmwareUpdateStartedInfoEvent","JobId": "5327","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.fc.1.fcs.4","TargetType": "FibreChannelSwitch","User": "UCP\\ucpadmin"}],"JobId": "5327","Name": "Update Fibre Channel switch firmware","Progress": 0,"StartTime": {"DateTime": "\/Date(1381181576155)\/","OffsetMinutes": 0},"Status": "Running","TargetId": "inst.UCP-12345.fc.1.fcs.4","TargetType": "FibreChannelSwitch","Type": "FibreChannelSwitchUpdateFirmware"}
Job resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List UCP jobs" on thefacing page
GET /api/jobs UCP View
"Get UCP job" on the facingpage
GET /api/jobs/{JOBID} UCP View
"List UCP jobs by filteredcriteria" on page 446
GET /api/jobs?(filters) UCP View
"Purge UCP jobs" onpage 464
POST /api/jobs/purgeUCP SystemAdministrator
438 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
List UCP jobs
This HTTP request uses the GET method on the /api/jobs URI.
Jobs unique to UCP are returned. vCenter jobs are not returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
One page of the most recent UCP jobs are returned. A page contains, bydefault, 100 jobs. Properties of jobs are detailed under "Get UCP job"below.
Example: List UCP jobs
Request HeaderGET https://ucpmanagement.ucp.local/api/jobs HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response BodyThe most recent 100 jobs are returned when no filtering criteria are addedto the URI.
Get UCP job
This HTTP request uses the GET method on the /api/jobs/{JOBID} URI,where {JOBID} specifies the ID of the UCP job that is to be returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
UCP jobs have the following properties.
Name Type Notes
(Common properties) See Common properties.
Chapter 2: UCP Director resources 439UCP Director API Reference
Job resources
Name Type Notes
CreatedBy StringThe identity of the user that started thejob. Regularly scheduled jobs are createdby UCP Director’s service account.
EndTime CollectionCollection of the following two timingmetrics.
DateTime DateTimeThe date and time the job ended. Nullwhile the job is running.
OffsetMinutes Int32 Offset from UTC time.
Events CollectionCollection of events associated with thejob.
(Common properties)See Common properties.Each eventcontains the common properties, minusthe Links.
InstanceId StringInstance ID of the UCP appliance wherethe job ran.
Arguments CollectionKey and value pairs of event arguments,where applicable.
Key StringKey value of the EventType for theDescription message.
Value StringValue to be substituted in for the Key inthe Description message.
CreatedBy String Username of the event initiator.
CollectionCollection of the following two timingmetrics.
DateTime Date and Time the event was started.
Int32 Offset from UTC time.
String The description of the event.
String Identifies the UCP event.
String The type of UCP event.
StringIdentifies the job associated with theevent.
StringRecommends action to be taken after jobcompletes.
String
The severity level of the event. Values:
• Info
• Warning
440 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
Name Type Notes
• Error
StringThe Id of the resource targeted by theevent. Always coupled with the followingproperty – TargetType.
String
The type of target associated with theevent. See the list of TargetType valuesunder the heading List UCP jobs by filteredcriteria.
JobId String Id of the job.
Name String The descriptive name of the job.
Progress Int32A rough estimate of job progress expressedas percent complete.
StartTime CollectionCollection of the following two timingmetrics.
DateTime Date and time when job began.
Int32 Offset from UTC time.
Status String
The status of the job. Values:
• Running
• Succeeded
• Error
TargetId StringThe Id of the resource targeted by the job.Always coupled with the following property– TargetType.
TargetType StringThe type of target associated with the job.See the list of TargetType values under theheading List UCP jobs by filtered criteria.
Example: Get details for a specific UCP job
In this example a job Id is appended to the URI. The specified job isreturned.
Request HeaderGET https://ucpmanagement.ucp.local/api/jobs/9176 HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Chapter 2: UCP Director resources 441UCP Director API Reference
Job resources
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "9176","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.9176","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/9176"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=9176"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/7b60677e-eb48-11e1-bcff-f78db160ca9c"}],"CreatedBy": "UCP\\ucpadmin","EndTime": {"DateTime": "\/Date(1386975512880)\/","OffsetMinutes": 0},"Events": [{"Id": "10947","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.10947","InstanceId": "UCP-12345","Arguments": [{"Key": "volumeid","Value": "210023:59 (00:00:3B)"}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386975317647)\/","OffsetMinutes": 0},"Description": "Successfully detached volume: 210023:59 (00:00:3B) fromserver.","EventId": "10947",
442 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
"EventType": "VolumeDetachForServerInfoEvent","JobId": "9176","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1.ser.7b60677e-eb48-11e1-bcff-f78db160ca9c","TargetType": "Server"},{"Id": "10953","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.10953","InstanceId": "UCP-12345","Arguments": [{"Key": "PortName","Value": "[Storage-System:210023\\Port:CL2-B\\DomainId:1],[Storage-System:210023\\Port:CL6-B\\DomainId:1],[Storage-System:210023\\Port:CL1-B\\DomainId:1],[Storage-System:210023\\Port:CL5-B\\DomainId:1]"}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386975417186)\/","OffsetMinutes": 0},"Description": "Removed the storage paths for this server on arrayports: [Storage-System:210023\\Port:CL2-B\\DomainId:1],[Storage-System:210023\\Port:CL6-B\\DomainId:1],[Storage-System:210023\\Port:CL1-B\\DomainId:1],[Storage-System:210023\\Port:CL5-B\\DomainId:1].","EventId": "10953","EventType": "StorageHsdRemovalInfoEvent","JobId": "9176","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1.ser.7b60677e-eb48-11e1-bcff-f78db160ca9c","TargetType": "Server"},{"Id": "10958","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.10958","InstanceId": "UCP-12345","Arguments": [{"Key": "ZoneName","Value": "Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL5B_HUS_VM_10_21_57_,Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL6B_HUS_VM_10_21_57_,Port1_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL5B_HUS_VM_10_21_57_,Port1_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL6B_HUS_VM_10_21_57_"},
Chapter 2: UCP Director resources 443UCP Director API Reference
Job resources
{"Key": "FabricName","Value": "Fabric B"}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386975479736)\/","OffsetMinutes": 0},"Description": "Removed Fibre Channel zone(s): Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL5B_HUS_VM_10_21_57_,Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL6B_HUS_VM_10_21_57_,Port1_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL5B_HUS_VM_10_21_57_,Port1_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL6B_HUS_VM_10_21_57_ from the active zoneset in fabric(s):Fabric B.","EventId": "10958","EventType": "ZoneRemoveForFabricInfoEvent","JobId": "9176","RecommendedAction": null,"Severity": "error","TargetId": "inst.UCP-12345.fc.1.fab.1","TargetType": "StorageFabric"},{"Id": "10962","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.10962","InstanceId": "UCP-12345","Arguments": [{"Key": "ZoneName","Value": "Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL1B_HUS_VM_10_21_57_,Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL2B_HUS_VM_10_21_57_,Port1_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL1B_HUS_VM_10_21_57_,Port1_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL2B_HUS_VM_10_21_57_"},{"Key": "FabricName","Value": "Fabric A"}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386975512386)\/","OffsetMinutes": 0},"Description": "Removed Fibre Channel zone(s): Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL1B_HUS_VM_10_21_57_,Port0_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL2B_HUS_VM_10_21_57_,Port1_7b60677e_eb48_11e1_bcff_
444 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
f78db160ca9c_CL1B_HUS_VM_10_21_57_,Port1_7b60677e_eb48_11e1_bcff_f78db160ca9c_CL2B_HUS_VM_10_21_57_ from the active zoneset in fabric(s):Fabric A.","EventId": "10962","EventType": "ZoneRemoveForFabricInfoEvent","JobId": "9176","RecommendedAction": null,"Severity": "error","TargetId": "inst.UCP-12345.fc.1.fab.2","TargetType": "StorageFabric"},{"Id": "10963","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.10963","InstanceId": "UCP-12345","Arguments": [
],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1386975512690)\/","OffsetMinutes": 0},"Description": "UCP has updated inventory details for storage resourcesthat are connected to host(s).","EventId": "10963","EventType": "StoragePlatformInventoryRefreshSucceedInfoEvent","JobId": "9176","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.stor.1","TargetType": "Storage"}],"JobId": "9176","JobType": "StorageDetachHostVolume","Name": "Detach a volume from a host.","Progress": 100,"StartTime": {"DateTime": "\/Date(1386975014793)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.cmp.1.ser.7b60677e-eb48-11e1-bcff-f78db160ca9c","TargetType": "Server"}
Chapter 2: UCP Director resources 445UCP Director API Reference
Job resources
List UCP jobs by filtered criteria
This HTTP request uses the GET method. The URI begins with /api/jobs?followed by a number of optional filtering criteria. Multiple values for asingle filter can be supplied in many cases, separated with the pipe symbol,“|”.
A filtered request can contain one or multiple of the following criteria. Usethe ampersand symbol when appending multiple filters.
• &status={STATUS} Status of the job, Running, Success, or Error.
• &targetType={TARGETTYPE} Target resource type (See below)
• &targetId={TARGETID} Target Id of a single resource
• &relation={RELATION} Self or subcomponent or both
• &jobType={JOBTYPE} Job type
• &jobId={JOBID} Job Id
• &fromDateTime={FROMDATETIME} Starting date and time
• &toDateTime={TODATETIME} Ending date and time
• &marker={MARKER} Id of the job
• &offset={OFFSET} Number of jobs to skip
• &count={COUNT} Quantity of jobs to return per page
TargetType values can be:
• Instance
• Ucp
• DatacenterConfiguration
• Configuration
• Ethernet
• Storage
446 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
• Compute
• Topology
• FibreChannel
• EthernetSwitch
• EthernetSwitchPort
• EthernetSwitchUnmanagedPorts
• EthernetSwitchConnectionInformation
• EthernetSwitchGlobalVlans
• SwitchConfigurationRetentionPolicy
• EthernetFeatures
• FibreChannelSwitch
• FibreChannelSwitchPort
• FibreChannelSwitchConnectionInformation
• ServerElementManager
• DisasterRecoveryManager
• ProtectedVolume
• Server
• ServerHostBusAdapterPort
• ServerNetworkInterface
• StorageSystem
• StorageElementManager
• Chassis
• ServerImage
• MailRecipientList
Chapter 2: UCP Director resources 447UCP Director API Reference
Job resources
• StorageFabric
• StorageVolume
• StorageZone
• Cluster
• Host
• SnmpConfigurationSettings
• MonitorSettings
• EthernetSwitchBackup
• CopyGroup
• PrivacyProtocols
• Job
• Event
• ServerType
• StoragePool
• StorageJournal
• StorageJournalVolume
• StoragePort
• StorageParityGroup
• StoragePhysicalDevice
• StorageVolumePath
• StorageProcessor
• VirtualManager
• Package
• VirtualMachine
448 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
• VirtualNic
• VirtualSwitch
• VirtualSwitchPort
• VirtualSwitchPortProfile
• SitePair
• ReplicationGroup
• ReplicatedVolumePair
• TestVolumePair
• User
• ServiceTemplate
• ServiceTemplateVolume
• HostProfile
• UserPermissionList
• AuthenticationProtocols
• SiteRegistration
• Role
The following paging controls can optionally be added to the URI.
Name Type Notes
marker Integer
Specifies the marker that was returned inresponse to a previous request. Marker isused for paging through results. Passing ina marker value from the oldest jobreturned by a previous request will requestthe following page of data.
offset IntegerSpecifies the number of jobs to be skipped.A negative value skips forward in time fromthe marker.
Chapter 2: UCP Director resources 449UCP Director API Reference
Job resources
Name Type Notes
count IntegerSpecifies the maximum number of jobs tobe returned. Nomore than 100 jobs (thedefault) will be returned.
Response body
The response body contains a list of the jobs which satisfy the filter orpaging criteria. Details regarding job properties are listed under thesubheading "Get UCP job" on page 439.
Example: Get page 1 of UCP jobs
In this example, the count value limits the number of jobs per page to justfive. The most recent five jobs are returned.
Request HeaderGET https://ucpmanagement.ucp.local/api/jobs?count=5 HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Jobs": [{"Id": "16257","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16257","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16257"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16257"}],"CreatedBy": "ucp\\svc_ucp",
450 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
"EndTime": {"DateTime": "\/Date(1387216359397)\/","OffsetMinutes": 0},"Events": [{"Id": "15067","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.15067","InstanceId": "UCP-12345","Arguments": [
],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1387216359339)\/","OffsetMinutes": 0},"Description": "UCP has successfully updated the inventory for server.","EventId": "15067","EventType": "ServerInventoryRefreshSucceedInfoEvent","JobId": "16257","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"}],"JobId": "16257","JobType": "ServerRefreshInventory","Name": "Refresh server inventory.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387216358288)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"},{"Id": "16256","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16256","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16256"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"
Chapter 2: UCP Director resources 451UCP Director API Reference
Job resources
},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16256"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {"DateTime": "\/Date(1387216239523)\/","OffsetMinutes": 0},"Events": [{"Id": "15065","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.15065","InstanceId": "UCP-12345","Arguments": [
],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1387216239457)\/","OffsetMinutes": 0},"Description": "UCP has successfully updated the inventory for server.","EventId": "15065","EventType": "ServerInventoryRefreshSucceedInfoEvent","JobId": "16256","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"}],"JobId": "16256","JobType": "ServerRefreshInventory","Name": "Refresh server inventory.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387216238282)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"},{"Id": "16255","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16255","InstanceId": "UCP-12345","Links": [
452 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16255"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16255"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/instance"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {"DateTime": "\/Date(1387216195813)\/","OffsetMinutes": 0},"Events": [
],"JobId": "16255","JobType": "MonitorRefreshHealth","Name": "Refresh health information for all elements.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387216170338)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345","TargetType": "Instance"},{"Id": "16254","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16254","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16254"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events",
Chapter 2: UCP Director resources 453UCP Director API Reference
Job resources
"Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16254"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {"DateTime": "\/Date(1387216186827)\/","OffsetMinutes": 0},"Events": [
],"JobId": "16254","JobType": "MonitorRefreshStoragePerformance","Name": "Refresh performance data for storage system.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387216170320)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.stor.1","TargetType": "Storage"},{"Id": "16253","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16253","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16253"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16253"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {"DateTime": "\/Date(1387216196983)\/","OffsetMinutes": 0},"Events": [
],"JobId": "16253","JobType": "MonitorRefreshEthernetPerformance","Name": "Refresh performance data for Ethernet switches.",
454 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
"Progress": 100,"StartTime": {"DateTime": "\/Date(1387216170307)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.eth.1","TargetType": "Ethernet"}],"Marker": 16257}
Example: Get page 2 of UCP jobs
In this example, job 16257 is designated as a starting point. From there,five pages are skipped and the next five jobs are returned.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/jobs?marker=16257&offset=5&count=5HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Jobs": [{"Id": "16252","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16252","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16252"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16252"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {
Chapter 2: UCP Director resources 455UCP Director API Reference
Job resources
"DateTime": "\/Date(1387216198417)\/","OffsetMinutes": 0},"Events": [
],"JobId": "16252","JobType": "MonitorRefreshFibreChannelPerformance","Name": "Refresh performance data for Fibre Channel switches.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387216170298)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.fc.1","TargetType": "FibreChannel"},{"Id": "16251","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16251","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16251"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16251"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {"DateTime": "\/Date(1387216119527)\/","OffsetMinutes": 0},"Events": [{"Id": "15064","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.15064","InstanceId": "UCP-12345","Arguments": [
],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {
456 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
"DateTime": "\/Date(1387216119466)\/","OffsetMinutes": 0},"Description": "UCP has successfully updated the inventory for server.","EventId": "15064","EventType": "ServerInventoryRefreshSucceedInfoEvent","JobId": "16251","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"}],"JobId": "16251","JobType": "ServerRefreshInventory","Name": "Refresh server inventory.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387216118274)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"},{"Id": "16250","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16250","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16250"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16250"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {"DateTime": "\/Date(1387215999547)\/","OffsetMinutes": 0},"Events": [{"Id": "15063","ResourceType": "Event",
Chapter 2: UCP Director resources 457UCP Director API Reference
Job resources
"GlobalResourceId": "inst.UCP-12345.event.15063","InstanceId": "UCP-12345","Arguments": [
],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1387215999468)\/","OffsetMinutes": 0},"Description": "UCP has successfully updated the inventory for server.","EventId": "15063","EventType": "ServerInventoryRefreshSucceedInfoEvent","JobId": "16250","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"}],"JobId": "16250","JobType": "ServerRefreshInventory","Name": "Refresh server inventory.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387215998255)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"},{"Id": "16249","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16249","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16249"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16249"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {
458 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
"DateTime": "\/Date(1387215879957)\/","OffsetMinutes": 0},"Events": [{"Id": "15050","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.15050","InstanceId": "UCP-12345","Arguments": [
],"CreatedBy": "ucp\\svc_ucp","CreatedTime": {"DateTime": "\/Date(1387215879783)\/","OffsetMinutes": 0},"Description": "UCP has successfully updated the inventory for server.","EventId": "15050","EventType": "ServerInventoryRefreshSucceedInfoEvent","JobId": "16249","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"}],"JobId": "16249","JobType": "ServerRefreshInventory","Name": "Refresh server inventory.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387215878254)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345.cmp.1","TargetType": "Compute"},{"Id": "16248","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16248","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16248"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},
Chapter 2: UCP Director resources 459UCP Director API Reference
Job resources
{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16248"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/instance"}],"CreatedBy": "ucp\\svc_ucp","EndTime": {"DateTime": "\/Date(1387215898877)\/","OffsetMinutes": 0},"Events": [
],"JobId": "16248","JobType": "MonitorRefreshHealth","Name": "Refresh health information for all elements.","Progress": 100,"StartTime": {"DateTime": "\/Date(1387215870355)\/","OffsetMinutes": 0},"Status": "Success","TargetId": "inst.UCP-12345","TargetType": "Instance"}],"Marker": 16257}
Example: Get Running jobs
In this example, running jobs are requested.
Request HeaderGET https://ucpmanagement.ucp.local/api/jobs?status=Running HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Jobs": [{"Id": "16271","ResourceType": "Job",
460 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
"GlobalResourceId": "inst.UCP-12345.job.16271","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16271"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16271"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/65d1fc27-0917-11e2-bafc-f267d6c84076"}],"CreatedBy": "UCP\\ucpadmin","EndTime": null,"Events": [
],"JobId": "16271","JobType": "StorageDetachHostVolume","Name": "Detach a volume from a host.","Progress": 0,"StartTime": {"DateTime": "\/Date(1387216897187)\/","OffsetMinutes": 0},"Status": "Running","TargetId": "inst.UCP-12345.cmp.1.ser.65d1fc27-0917-11e2-bafc-f267d6c84076","TargetType": "Server"}],"Marker": 16271}
Example: Get UCP jobs targeting a specific server
In this example, all jobs related the specified server are requested. For thesake of brevity, just the first job is shown here.
Chapter 2: UCP Director resources 461UCP Director API Reference
Job resources
Request HeaderGEThttps://ucpmanagement.ucp.local/api/jobs?targetType=server&targetId=inst.UCP-12345.cmp.1.ser.7b60677e-eb48-11e1-bcff-f78db160ca9c HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Jobs": [{"Id": "16174","ResourceType": "Job","GlobalResourceId": "inst.UCP-12345.job.16174","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs\/16174"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/jobs"},{"Rel": "events","Href": "https:\/\/ucpmanagement.ucp.local\/api\/events?jobId=16174"},{"Rel": "target","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/7b60677e-eb48-11e1-bcff-f78db160ca9c"}],"CreatedBy": "UCP\\ucpadmin","EndTime": {"DateTime": "\/Date(1387214235447)\/","OffsetMinutes": 0},"Events": [{"Id": "15012","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.15012","InstanceId": "UCP-12345","Arguments": [{"Key": "IpAddress",
462 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
"Value": "10.21.57.215"},{"Key": "PortNumber","Value": "TenGigabitEthernet 0\/15"},{"Key": "vlans","Value": "61,126"},{"Key": "HostName","Value": "7b60677e-eb48-11e1-bcff-f78db160ca9c"}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1387213961044)\/","OffsetMinutes": 0},"Description": "VLANs for Ethernet Switch with IP address: 10.21.57.215,port: TenGigabitEthernet 0\/15 were configured to match the VLANs 61,126on the host: 7b60677e-eb48-11e1-bcff-f78db160ca9c.","EventId": "15012","EventType": "EthernetSwtichHostVlanConfiguredInfoEvent","JobId": "16174","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1.ser.7b60677e-eb48-11e1-bcff-f78db160ca9c","TargetType": "Server"},{"Id": "15013","ResourceType": "Event","GlobalResourceId": "inst.UCP-12345.event.15013","InstanceId": "UCP-12345","Arguments": [{"Key": "IpAddress","Value": "10.21.57.214"},{"Key": "PortNumber","Value": "TenGigabitEthernet 0\/15"},{"Key": "vlans","Value": "61,126"},{"Key": "HostName","Value": "7b60677e-eb48-11e1-bcff-f78db160ca9c"
Chapter 2: UCP Director resources 463UCP Director API Reference
Job resources
}],"CreatedBy": "UCP\\ucpadmin","CreatedTime": {"DateTime": "\/Date(1387213996246)\/","OffsetMinutes": 0},"Description": "VLANs for Ethernet Switch with IP address: 10.21.57.214,port: TenGigabitEthernet 0\/15 were configured to match the VLANs 61,126on the host: 7b60677e-eb48-11e1-bcff-f78db160ca9c.","EventId": "15013","EventType": "EthernetSwtichHostVlanConfiguredInfoEvent","JobId": "16174","RecommendedAction": null,"Severity": "info","TargetId": "inst.UCP-12345.cmp.1.ser.7b60677e-eb48-11e1-bcff-f78db160ca9c","TargetType": "Server"}
Purge UCP jobs
This HTTP request uses the POST method on the /api/jobs/purge URI.
UCP jobs older than the retention policy are deleted. The retention policy isset in vCenter Server Settings, Database Retention Policy. Only UCP jobsare purged, and they are only removed from UCP database. vCenter jobsand vCenter database are not affected.
The UCP System Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Purge UCP jobs
Request HeaderPOST https://ucpmanagement.ucp.local/api/jobs/purge HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
464 Chapter 2: UCP Director resources
UCP Director API Reference
Job resources
Response BodyThe system executes a job named "Purge UCP Director jobs that exceed theretention policy".
Monitoring resourcesThis set of API is used to set SNMP configurations and reporting modes atthe level of resource types. It also reports an aggregated health state pereach resource type. Resource types are Ethernet, FibreChannel, storage,compute and UCP. The health states can also be reported up to theDatacenter Director level. The API requests must be directed to themonitoring service at https://<ucpManagementIP>/monitoring, whereasother UCP Director API are addressed to https://<ucpManagementIP>/api.
The table below provides uses for monitoring resources. Additional detailsfor each use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List all resourcetypes" on the nextpage
GET /monitoring/resourceTypes UCP View
"List resourceswithin a resourcetype" on page 502
GET/monitoring/resourceTypes/{RESOURCETYPE}
UCP View
"Set monitor modefor a resource type ora resource" onpage 506
POST/monitoring/resourceTypes/{RESOURCETYPE}/monitorMode
UCP SystemAdministrator
"Get monitor modefor a resource type ora resource" onpage 508
GET/monitoring/resourceTypes/{RESOURCETYPE}/monitorMode
UCP View
"Configure SNMPsettings" onpage 510
POST/monitoring/resourceTypes/{RESOURCETYPE}/snmpConfiguration
UCP SystemAdministrator
"Get SNMP settings"on page 512
GET/monitoring/resourcetypes/{RESOURCETYPE}/snmpConfiguration
UCP SystemAdministrator
"Get SNMP trapreceiver" onpage 513
GET /monitoring/snmpTrapReceiver UCP View
"Refresh monitorstates" on page 515
POST /monitoring/monitorStatesUCP SystemAdministrator
Chapter 2: UCP Director resources 465UCP Director API Reference
Monitoring resources
Request Method URIvCenterPrivilege
"Get monitor statefor a resource type"on page 516
GET/monitoring/monitorStates?resourceType={RESOURCETYPE}
UCP View
List all resource types
This HTTP request uses the GET method on the /monitoring/resourceTypesURI. The returned list includes all resource types for which monitoringstates are measured, most of which include configurable performancecounters.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body returns all resource types. Resource types have the propertiesshown in the following chart.
Name Type Notes
MonitorMode String
Identifies what mode of monitoring thatthe resource type is in.
Values can be:
• Report• Monitor• Off
PerformanceCounters CollectionList of performance counters for theresource type.
StringDisplay name of the performancecounter.
StringMetric unit in which the performancecounter is measured.
String Name of the performance counter.
CollectionCollection of threshold information forthe specified performance counter.
Int32Number of recent events the monitorwill keep in its memory
466 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
Name Type Notes
Int32Number of times a specific event mustoccur in order to be treated as an event
BooleanDetermines whether the Thresholdfeature is in use or not
PerformanceCounterThresholdRules CollectionCollection of condition and value pairs forthe specified rule
String Condition for the threshold rule.
FloatThe numerical value for the thresholdrule.
ResourceType String Type of resource
SnmpConfiguration CollectionCollection of SNMP information for thespecified resource type.
StringThe authentication protocol currentlyused by the specified resource type.
StringThe privacy protocol currently used bythe specified resource type.
StringThe version of SNMP supported by thespecified resource type.
StringThe SNMP user name used by thespecified resource type.
Username is Null for Compute andStorage.
SupportedAuthenticationProtocols String
The list of SNMP authentication protocolssupported by the resource type.
Ethernet and Fibre Channel support:
• NoAuth
• MD5
• SHA1
Empty for Compute and Storageelement types which useCommunityString
SupportedPrivacyProtocols String
The list of SNMP privacy protocolssupported by the resource type.
Ethernet values:
• NoPriv
Chapter 2: UCP Director resources 467UCP Director API Reference
Monitoring resources
Name Type Notes
• AES128• DES
FibreChannel values:• NoPriv• AES128• DES
Empty for Compute and Storageelement types which useCommunityString
Resource types are listed below along with their associated performance counters.
StoragePort:
DisplayName Name
Average I/O Rate AvgIoRate
Average Transfer Rate AvgXferRate
StorageVolume:
DisplayName Name
Random Total I/O Rate RandomTotalIoRate
Random Total Transfer Rate RandomTotalXferRate
Read Hit Percentage ReadHitPct
Read I/O Rate ReadIoRate
Read Response Rate ReadResponseRate
Read Transfer Rate ReadXferRate
Sequential Total I/O Rate SequentialTotalIoRate
Sequential Total Transfer Rate SequentialTotalXferRate
Total Response Rate TotalResponseRate
Write Hit PercentageWriteHitPct
Write I/O RateWriteIoRate
Write Response RateWriteResponseRate
Write Transfer RateWriteXferRate
468 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
Total Capacity TotalCapacity
Used Capacity UsedCapacity
Used Percentage UsedPercentage
StoragePool:
DisplayName Name
Read Response Rate ReadResponseRate
Write Response RateWriteResponseRate
Read I/O Rate ReadIoRate
Write I/O RateWriteIoRate
Capacity Capacity
Subscribed Capacity SubscribedCapacity
Used Capacity UsedCapacity
Current Subscription Percentage CurrentSubscriptionPercentage
Used Percentage UsedPercentage
Subscription Limit Percentage SubscriptionLimitPercentage
StorageProcessor:
DisplayName Name
Processor Busy Percentage ProcessorBusyPct
EthernetSwitchPort:
DisplayName Name
Data Receive Rate DataReceiveRate
Unicast Receives UnicastReceives
Multicast Receives MulticastReceives
Broadcast Receives BroadcastReceives
Packets Received PacketsReceived
Receive Packets Dropped ReceivePacketsDropped
Packet Receive Errors PacketReceiveErrors
Chapter 2: UCP Director resources 469UCP Director API Reference
Monitoring resources
Unknown Protocol Packets UnknownProtocolPackets
Data Transmit Rate DataTransmitRate
Unicast Transmits UnicastTransmits
Multicast Transmits MulticastTransmits
Broadcast Transmits BroadcastTransmits
Packets Transmitted PacketsTransmitted
Transmit Packets Dropped TransmitPacketsDropped
Packet Transmit Errors PacketTransmitErrors
StorageParityGroup
DisplayName Name
Busy Percentage BusyPct
Random Read I/O Percentage RandomReadIoPct
Random Read I/O Rate RandomReadIoRate
Random Read Transfer Percentage RandomReadXferPct
Random Read Transfer Rate RandomReadXferRate
Random Total I/O Rate RandomTotalIoRate
Random Total Transfer Rate RandomTotalXferRate
RandomWrite I/O Percentage RandomWriteIoPct
RandomWrite I/O Rate RandomWriteIoRate
RandomWrite Transfer Percentage RandomWriteXferPct
RandomWrite Transfer Rate RandomWriteXferRate
Read Hit Percentage ReadHitPct
Read I/O Percentage ReadIoPct
Read I/O Rate ReadIoRate
Read Transfer Percentage ReadXferPct
Read Transfer Rate ReadXferRate
Sequential Read I/O Percentage SequentialReadIoPct
470 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
Sequential Read I/O Rate SequentialReadIoRate
Sequential Read Transfer Percentage SequentialReadXferPct
Sequential Read Transfer Rate SequentialReadXferRate
Sequential Total I/O Rate SequentialTotalIoRate
Sequential Total Transfer Rate SequentialTotalXferRate
SequentialWrite I/O Percentage SequentialWriteIoPercentage
SequentialWrite I/O Rate SequentialWriteIoRate
SequentialWrite Transfer Percentage SequentialWriteXferPct
SequentialWrite Transfer Rate SequentialWriteXferRate
Write I/O PercentageWriteIoPct
Write Hit PercentageWriteHitPct
Write I/O RateWriteIoRate
Write Transfer PercentageWriteXferPct
Write Transfer RateWriteXferRate
StorageJournal
DisplayName Name
Used Percentage UsedPercentage
EthernetSwitch
DisplayName Name
CPUUsage CPUUsage
Memory UsageMemoryUsage
StorageSystem
DisplayName Name
CacheMemory Usage CacheMemoryUsage
CacheMemory Usage Percent CacheMemoryUsagePct
CacheWrite Pending CacheWritePending
CacheWrite Pending Percentage CacheWritePendingPct
Chapter 2: UCP Director resources 471UCP Director API Reference
Monitoring resources
Physical Space PhysicalSpace
Reserved Space ReservedSpace
Free Space FreeSpace
Allocated Space AllocatedSpace
Unallocated Space UnallocatedSpace
FibreChannelSwitchPort
DisplayName Name
Data Transmit Rate DataTransmitRate
Data Receive Rate DataReceiveRate
Frame Transmit Rate FrameTransmitRate
Frame Receive Rate FrameReceiveRate
Multicast Receives MulticastReceives
Multicast Transmits MulticastTransmits
Buffer Credit Zero State Count BufferCreditZeroStateCount
Encoding Disparity Count EncodingDisparityCount
Too Long Frames TooLongFrames
Invalid Ordered Sets InvalidOrderedSets
Link Failures LinkFailures
SyncLosses Loss of Synchronization Errors
SignalLosses Loss of Signal Errors
SignalLosses Loss of Signal Errors
PrimSeqProtoErrors Primitive Sequence Protocol Errors
InvalidTransmittedWords Invalid Transmitted Words
CRCErrors CRC Errors
DelimiterErrors Delimiter Errors
Address Errors AddressErrors
Received Link Reset ReceivedLinkReset
472 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
Transmitted Link Reset TransmittedLinkReset
Received Offline Sequence ReceivedOfflineSequence
Transmitted Offline Sequence TransmittedOfflineSequence
Example: Get monitor information for all resource types
This example displays monitoring information for all resource types.
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/resourceTypes HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Random Total I/O Rate","Id":1,"MetricUnit":"IOPS","Name":"RandomTotalIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Total Transfer Rate","Id":2,"MetricUnit":"MBps","Name":"RandomTotalXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read Hit Percentage","Id":3,"MetricUnit":"%",
Chapter 2: UCP Director resources 473UCP Director API Reference
Monitoring resources
"Name":"ReadHitPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read I/O Rate","Id":4,"MetricUnit":"IOPS","Name":"ReadIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read Response Rate","Id":5,"MetricUnit":"µsec","Name":"ReadResponseRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read Transfer Rate","Id":6,"MetricUnit":"MBps","Name":"ReadXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Total I/O Rate","Id":7,"MetricUnit":"IOPS","Name":"SequentialTotalIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,
474 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Total Transfer Rate","Id":8,"MetricUnit":"MBps","Name":"SequentialTotalXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Total Response Rate","Id":9,"MetricUnit":"µsec","Name":"TotalResponseRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write Hit Percentage","Id":10,"MetricUnit":"%","Name":"WriteHitPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write I/O Rate","Id":11,"MetricUnit":"IOPS","Name":"WriteIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write Response Rate",
Chapter 2: UCP Director resources 475UCP Director API Reference
Monitoring resources
"Id":12,"MetricUnit":"µsec","Name":"WriteResponseRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write Transfer Rate","Id":13,"MetricUnit":"MBps","Name":"WriteXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Total Capacity","Id":14,"MetricUnit":"B","Name":"TotalCapacity","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Used Capacity","Id":15,"MetricUnit":"B","Name":"UsedCapacity","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Used Percentage","Id":16,"MetricUnit":"%","Name":"UsedPercentage","PerformanceCounterThreshold":{"DampingHistory":1,
476 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"StorageVolume","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[
],"ResourceType":"Compute","SnmpConfiguration":{"AuthenticationProtocol":"None","PrivacyProtocol":"None","SnmpVersion":"V2c","UserName":null},"SupportedAuthenticationProtocols":"None","SupportedPrivacyProtocols":"None"},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Cache Memory Usage","Id":64,"MetricUnit":"MB","Name":"CacheMemoryUsage","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Cache Memory Usage Percentage","Id":65,"MetricUnit":"%","Name":"CacheMemoryUsagePct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},
Chapter 2: UCP Director resources 477UCP Director API Reference
Monitoring resources
{"DisplayName":"Cache Write Pending","Id":66,"MetricUnit":"MB","Name":"CacheWritePending","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Cache Write Pending Percentage","Id":67,"MetricUnit":"%","Name":"CacheWritePendingPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Physical Space","Id":68,"MetricUnit":"B","Name":"PhysicalSpace","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Reserved Space","Id":69,"MetricUnit":"B","Name":"ReservedSpace","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Free Space","Id":70,"MetricUnit":"B","Name":"FreeSpace",
478 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Allocated Space","Id":71,"MetricUnit":"B","Name":"AllocatedSpace","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Unallocated Space","Id":72,"MetricUnit":"B","Name":"UnallocatedSpace","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"StorageSystem","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Data Transmit Rate","Id":90,"MetricUnit":"Mbps","Name":"DataTransmitRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{
Chapter 2: UCP Director resources 479UCP Director API Reference
Monitoring resources
"DisplayName":"Data Recive Rate","Id":91,"MetricUnit":"Mbps","Name":"DataReceiveRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Frame Transmit Rate","Id":92,"MetricUnit":"FPS","Name":"FrameTransmitRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Frame Receive Rate","Id":93,"MetricUnit":"FPS","Name":"FrameReceiveRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Multicast Receives","Id":94,"MetricUnit":"counts","Name":"MulticastReceives","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Multicast Transmits","Id":95,"MetricUnit":"counts","Name":"MulticastTransmits","PerformanceCounterThreshold":{
480 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Buffer Credit Zero State Count","Id":96,"MetricUnit":"counts","Name":"BufferCreditZeroStateCount","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Encoding Disparity Count","Id":97,"MetricUnit":"counts","Name":"EncodingDisparityCount","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Too Long Frames","Id":98,"MetricUnit":"counts","Name":"TooLongFrames","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Invalid Ordered Sets","Id":99,"MetricUnit":"counts","Name":"InvalidOrderedSets","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}
Chapter 2: UCP Director resources 481UCP Director API Reference
Monitoring resources
},{"DisplayName":"Link Failures","Id":100,"MetricUnit":"counts","Name":"LinkFailures","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Loss of Synchronization Errors","Id":101,"MetricUnit":"counts","Name":"SyncLosses","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Loss of Signal Errors","Id":102,"MetricUnit":"counts","Name":"SignalLosses","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Primitive Sequence Protocol Errors","Id":103,"MetricUnit":"counts","Name":"PrimSeqProtoErrors","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Invalid Transmitted Words","Id":104,"MetricUnit":"counts",
482 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"Name":"InvalidTransmittedWords","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"CRC Errors","Id":105,"MetricUnit":"counts","Name":"CRCErrors","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Delmiter Errors","Id":106,"MetricUnit":"counts","Name":"DelimiterErrors","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Address Errors","Id":107,"MetricUnit":"counts","Name":"AddressErrors","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Received Link Reset","Id":108,"MetricUnit":"counts","Name":"ReceivedLinkReset","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,
Chapter 2: UCP Director resources 483UCP Director API Reference
Monitoring resources
"PerformanceCounterThresholdRules":null}},{"DisplayName":"Transmitted Link Reset","Id":109,"MetricUnit":"counts","Name":"TransmittedLinkReset","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Received Offline Sequence","Id":110,"MetricUnit":"counts","Name":"ReceivedOfflineSequence","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Transmitted Offline Sequence","Id":111,"MetricUnit":"counts","Name":"TransmittedOfflineSequence","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"FibreChannelSwitchPort","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Average I/O Rate","Id":29,"MetricUnit":"IOPS","Name":"AvgIoRate",
484 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Average Transfer Rate","Id":30,"MetricUnit":"MBps","Name":"AvgXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"StoragePort","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Average Tag Count","Id":17,"MetricUnit":"counts","Name":"AvgTagCount","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Busy Percentage","Id":18,"MetricUnit":"%","Name":"BusyPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],
Chapter 2: UCP Director resources 485UCP Director API Reference
Monitoring resources
"ResourceType":"StoragePhysicalDevice","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Read Response Rate","Id":19,"MetricUnit":"µsec","Name":"ReadResponseRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write Response Rate","Id":20,"MetricUnit":"µsec","Name":"WriteResponseRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read I/O Rate","Id":21,"MetricUnit":"IOPS","Name":"ReadIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write I/O Rate","Id":22,"MetricUnit":"IOPS","Name":"WriteIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,
486 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"PerformanceCounterThresholdRules":null}},{"DisplayName":"Capacity","Id":23,"MetricUnit":"B","Name":"Capacity","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Subscribed Capacity","Id":24,"MetricUnit":"B","Name":"SubscribedCapacity","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Used Capacity","Id":25,"MetricUnit":"B","Name":"UsedCapacity","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Current Subscription Percentage","Id":26,"MetricUnit":"%","Name":"CurrentSubscriptionPercentage","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Used Percentage",
Chapter 2: UCP Director resources 487UCP Director API Reference
Monitoring resources
"Id":27,"MetricUnit":"%","Name":"UsedPercentage","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Subscription Limit Percentage","Id":28,"MetricUnit":"%","Name":"SubscriptionLimitPercentage","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"StoragePool","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[
],"ResourceType":"Ethernet","SnmpConfiguration":{"AuthenticationProtocol":"SHA1","PrivacyProtocol":"AES128","SnmpVersion":"V3","UserName":"ucpsnmpuser"},"SupportedAuthenticationProtocols":"MD5,NoAuth,SHA1","SupportedPrivacyProtocols":"AES128,DES,NoPriv"},{"MonitorMode":"Report","PerformanceCounters":[
],"ResourceType":"FibreChannelSwitch","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},
488 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Processor Busy Percentage","Id":31,"MetricUnit":"%","Name":"ProcessorBusyPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"StorageProcessor","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[
],"ResourceType":"Storage","SnmpConfiguration":{"AuthenticationProtocol":"None","PrivacyProtocol":"None","SnmpVersion":"V1","UserName":null},"SupportedAuthenticationProtocols":"None","SupportedPrivacyProtocols":"None"},{"MonitorMode":"Report","PerformanceCounters":[
],"ResourceType":"Server","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Data Recive Rate","Id":73,"MetricUnit":"Mbps",
Chapter 2: UCP Director resources 489UCP Director API Reference
Monitoring resources
"Name":"DataReceiveRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Unicast Receives","Id":74,"MetricUnit":"counts","Name":"UnicastReceives","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Multicast Receives","Id":75,"MetricUnit":"counts","Name":"MulticastReceives","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Broadcast Receives","Id":76,"MetricUnit":"counts","Name":"BroadcastReceives","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Packets Received","Id":77,"MetricUnit":"counts","Name":"PacketsReceived","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,
490 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"PerformanceCounterThresholdRules":null}},{"DisplayName":"Receive Packets Dropped","Id":78,"MetricUnit":"counts","Name":"ReceivePacketsDropped","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Packet Receive Errors","Id":79,"MetricUnit":"counts","Name":"PacketReceiveErrors","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Unknown Protocol Packets","Id":80,"MetricUnit":"counts","Name":"UnknownProtocolPackets","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Data Transmit Rate","Id":81,"MetricUnit":"Mbps","Name":"DataTransmitRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Unicast Transmits",
Chapter 2: UCP Director resources 491UCP Director API Reference
Monitoring resources
"Id":82,"MetricUnit":"counts","Name":"UnicastTransmits","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Multicast Transmits","Id":83,"MetricUnit":"counts","Name":"MulticastTransmits","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Broadcast Transmits","Id":84,"MetricUnit":"counts","Name":"BroadcastTransmits","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Packets Transmitted","Id":85,"MetricUnit":"counts","Name":"PacketsTransmitted","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Transmit Packets Dropped","Id":86,"MetricUnit":"counts","Name":"TransmitPacketsDropped","PerformanceCounterThreshold":{"DampingHistory":1,
492 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Packet Transmit Errors","Id":87,"MetricUnit":"counts","Name":"PacketTransmitErrors","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"EthernetSwitchPort","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[
],"ResourceType":"Chassis","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Busy Percentage","Id":32,"MetricUnit":"%","Name":"BusyPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Read I/O Percentage","Id":33,"MetricUnit":"%","Name":"RandomReadIoPct",
Chapter 2: UCP Director resources 493UCP Director API Reference
Monitoring resources
"PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Read I/O Rate","Id":34,"MetricUnit":"IOPS","Name":"RandomReadIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Read Transfer Percentage","Id":35,"MetricUnit":"%","Name":"RandomReadXferPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Read Transfer Rate","Id":36,"MetricUnit":"MBps","Name":"RandomReadXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Total I/O Rate","Id":37,"MetricUnit":"IOPS","Name":"RandomTotalIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null
494 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
}},{"DisplayName":"Random Total Transfer Rate","Id":38,"MetricUnit":"MBps","Name":"RandomTotalXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Write I/O Percentage","Id":39,"MetricUnit":"%","Name":"RandomWriteIoPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Write I/O Rate","Id":40,"MetricUnit":"IOPS","Name":"RandomWriteIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Write Transfer Percentage","Id":41,"MetricUnit":"%","Name":"RandomWriteXferPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Random Write Transfer Rate","Id":42,
Chapter 2: UCP Director resources 495UCP Director API Reference
Monitoring resources
"MetricUnit":"MBps","Name":"RandomWriteXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read Hit Percentage","Id":43,"MetricUnit":"%","Name":"ReadHitPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read I/O Percentage","Id":44,"MetricUnit":"%","Name":"ReadIoPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read I/O Rate","Id":45,"MetricUnit":"IOPS","Name":"ReadIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read Transfer Percentage","Id":46,"MetricUnit":"%","Name":"ReadXferPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,
496 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Read Transfer Rate","Id":47,"MetricUnit":"MBps","Name":"ReadXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Read I/O Percentage","Id":48,"MetricUnit":"%","Name":"SequentialReadIoPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Read I/O Rate","Id":49,"MetricUnit":"IOPS","Name":"SequentialReadIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Read Transfer Percentage","Id":50,"MetricUnit":"%","Name":"SequentialReadXferPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{
Chapter 2: UCP Director resources 497UCP Director API Reference
Monitoring resources
"DisplayName":"Sequential Read Transfer Rate","Id":51,"MetricUnit":"MBps","Name":"SequentialReadXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Total I/O Rate","Id":52,"MetricUnit":"IOPS","Name":"SequentialTotalIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Total Transfer Rate","Id":53,"MetricUnit":"MBps","Name":"SequentialTotalXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Write I/O Percentage","Id":54,"MetricUnit":"%","Name":"SequentialWriteIoPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Write I/O Rate","Id":55,"MetricUnit":"IOPS","Name":"SequentialWriteIoRate","PerformanceCounterThreshold":{
498 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Write Transfer Percentage","Id":56,"MetricUnit":"%","Name":"SequentialWriteXferPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Sequential Write Transfer Rate","Id":57,"MetricUnit":"MBps","Name":"SequentialWriteXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write I/O Percentage","Id":58,"MetricUnit":"%","Name":"WriteIoPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write Hit Percentage","Id":59,"MetricUnit":"%","Name":"WriteHitPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}
Chapter 2: UCP Director resources 499UCP Director API Reference
Monitoring resources
},{"DisplayName":"Write I/O Rate","Id":60,"MetricUnit":"IOPS","Name":"WriteIoRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write Transfer Percentage","Id":61,"MetricUnit":"%","Name":"WriteXferPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Write Transfer Rate","Id":62,"MetricUnit":"MBps","Name":"WriteXferRate","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"StorageParityGroup","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[
],"ResourceType":"FibreChannel","SnmpConfiguration":{"AuthenticationProtocol":"SHA1","PrivacyProtocol":"AES256","SnmpVersion":"V3",
500 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"UserName":"ucpsnmpuser"},"SupportedAuthenticationProtocols":"MD5,NoAuth,SHA1","SupportedPrivacyProtocols":"AES128,DES,NoPriv "},{"MonitorMode":"Report","PerformanceCounters":[
],"ResourceType":"Ucp","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"Used Percentage","Id":63,"MetricUnit":"%","Name":"UsedPercentage","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":[{"Condition":"TooHighError","Value":80},{"Condition":"TooHighWarning","Value":10}]}}],"ResourceType":"StorageJournal","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""},{"MonitorMode":"Report","PerformanceCounters":[{"DisplayName":"CPU Usage","Id":88,"MetricUnit":"%","Name":"CPUUsage",
Chapter 2: UCP Director resources 501UCP Director API Reference
Monitoring resources
"PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Memory Usage","Id":89,"MetricUnit":"%","Name":"MemoryUsage","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}}],"ResourceType":"EthernetSwitch","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""}}
List resources within a resource type
This HTTP request uses the GET method on the /monitoring/resourceTypes/{RESOURCETYPE} where {RESOURCETYPE} is one of the following:
• Chassis
• Compute
• Ethernet
• EthernetSwitch
• EthernetSwitchPort
• FibreChannel
• FibreChannelSwitch
• FibreChannelSwitchPort
• Server
502 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
• Storage
• StorageJournal
• StorageParityGroup
• StoragePhysicalDevice
• StoragePool
• StoragePort
• StorageProcessor
• StorageSystem
• StorageVolume
Request body
The body of this request must be empty.
Response body
For every resource type, as listed above, the applicable set of performancecounters and SNMP configuration information is displayed. The list ofproperties for the data returned are the same as in List all resource types.
Example: Get monitor information for StorageSystem
This example uses the StorageSystem as a resource type. Monitoringinformation is returned for the storage system.
Request HeaderGEThttps://ucpmanagement.ucp.local/monitoring/resourcetypes/StorageSystemHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"MonitorMode":"Report","PerformanceCounters":[{
Chapter 2: UCP Director resources 503UCP Director API Reference
Monitoring resources
"DisplayName":"Cache Memory Usage","Id":64,"MetricUnit":"MB","Name":"CacheMemoryUsage","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Cache Memory Usage Percentage","Id":65,"MetricUnit":"%","Name":"CacheMemoryUsagePct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Cache Write Pending","Id":66,"MetricUnit":"MB","Name":"CacheWritePending","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Cache Write Pending Percentage","Id":67,"MetricUnit":"%","Name":"CacheWritePendingPct","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Physical Space","Id":68,"MetricUnit":"B","Name":"PhysicalSpace","PerformanceCounterThreshold":{
504 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Reserved Space","Id":69,"MetricUnit":"B","Name":"ReservedSpace","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Free Space","Id":70,"MetricUnit":"B","Name":"FreeSpace","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Allocated Space","Id":71,"MetricUnit":"B","Name":"AllocatedSpace","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}},{"DisplayName":"Unallocated Space","Id":72,"MetricUnit":"B","Name":"UnallocatedSpace","PerformanceCounterThreshold":{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":null}
Chapter 2: UCP Director resources 505UCP Director API Reference
Monitoring resources
}],"ResourceType":"StorageSystem","SnmpConfiguration":null,"SupportedAuthenticationProtocols":"","SupportedPrivacyProtocols":""}
Set monitor mode for a resource type or a resource
This HTTP request uses the POST method on the/monitoring/resourceTypes/{RESOURCETYPE}/monitorMode URI.
The monitor mode describes how SNMP events from resources areprocessed by UCP.
If the specified {RESOURCETYPE} is Compute, Ethernet, FibreChannel, orStorage, do not specify a GlobalResourceId in the request body. AGlobalResourceId of a port is included in the request body only whenFibreChannelSwitchPort or EthernetSwitchPort is specified in the URI.
The resourceType specified in the URI can be:
• Compute
• Ethernet
• FibreChannel
• Storage
• FibreChannelSwitchPort
• EthernetSwitchPort
MonitorMode specified in the request body can be:
• Report
• Monitor
• Off
The UCP Administrator privilege is required.
Definition of modes:
506 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
• Report - Events will be monitored, logged, and reported to the virtualplatform.
• Monitor - Events will be monitored and logged but not reported to thevirtual platform.
• Off - Events will not be monitored, logged, or reported to the virtualplatform
The request body contains the following properties
Name Type Notes
GlobalResourceId StringOptionally specifies the global resource Idof one specific resource for which tochange the monitor mode.
MonitorMode String
The new mode for monitoring SNMPevents of the specified resource orresource type. Values:
• Report
• Monitor
• Off
Response body
When the request is accepted a job is started and the body of the responsecontains a job object which can also be requested form Get UCP job.
Example: Update monitor mode Ethernet switches to Report
In this example, the monitor mode for Ethernet switches is changed toReport.
Request HeaderPOST
https://ucpmanagement.ucp.local/monitoring/resourceTypes/Ethernet/monitorMode HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"MonitorMode":"Report"}
Response HeaderHTTP/1.1 202 Accepted
Chapter 2: UCP Director resources 507UCP Director API Reference
Monitoring resources
Response BodyThe system executes a job named "Update monitor mode".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Example: Update monitor mode for Ethernet switch port to Report
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Request HeaderPOSThttps://ucpmanagement.ucp.local/monitoring/resourceTypes/EthernetSwitchPort/monitorMode HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"MonitorMode":"Report","GlobalResourceId":"inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0/7"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update monitor mode".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get monitor mode for a resource type or a resource
This HTTP request uses the GET method on the /monitoring/resourceTypes/{RESOURCETYPE}/monitorMode URI, where {RESOURCETYPE} would beone of the following: Compute, Ethernet, or FibreChannel.
If the monitor mode of a specific resource is requested, the URI must beformatted as: /monitoring/resourceTypes/{RESOURCETYPE}/monitorMode?globalResourceId={GLOBALRESOURCEID}. Whenspecifying a {GLOBALRESOURCEID}, the associated {RESOURCETYPE}must be one of the following: FibreChannelSwitch, FibreChannelSwitchPort,EthernetSwitch, or EthernetSwitchPort.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
508 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
The response body contains the monitor mode for the specified resource orresource type.
Values may be:
• Report - Events will be monitored, logged, and reported to the virtualplatform.
• Monitor - Events will be monitored and logged but not reported to thevirtual platform.
• Off - Events will not be monitored, logged, or reported to the virtualplatform
Example: Get monitor mode for top level resource Ethernet
Request HeaderGEThttps://ucpmanagement.ucp.local/monitoring/resourceTypes/Ethernet/monitorMode HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body"Report"
Example: Get monitor mode for EthernetSwitchPort
This example gets the monitor mode for a specific Ethernet switch port.
Request HeaderGEThttps://ucpmanagement.ucp.local/monitoring/resourceTypes/EthernetSwitchPort/monitorMode?globalresourceId=inst.UCP-123-456-789.eth.1.net.1.port.TenGigabitEthernet 0/7 HTTP/1.1 Content-Type:application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body"Report"
Chapter 2: UCP Director resources 509UCP Director API Reference
Monitoring resources
Configure SNMP settings
This HTTP request uses the POST method on monitoring/resourceTypes/{RESOURCETYPE}/SnmpConfiguration URI, where {RESOURCETYPE}specifies the resource type to apply SNMP configurations to.
Resource types which have configurable settings are:
• Ethernet
• FibreChannel
• Compute
• Storage
This API requires the Administrator role per each resource type. Forexample, changing the SNMP settings for Compute requires the UCP ServerAdministrator role.
Note that the Storage and Compute SNMP community string must matchexactly the string that is manually set on HCSM and HDvM. (HitachiCompute Systems Manager and Hitachi Device Manager). On theotherhand, the Ethernet and FibreChannel settings which are input throughthis API are automatically configured by UCP onto the physical switches.
Request body
The request body consists of the parameters listed in the following chart.
Name Type Notes
AuthenticationPassword String
Specifies the new password to be usedwiththe authentication protocol. Valid values, byelement type:
• Ethernet: Any string 8-32 characters longstarting with alphanumeric characterswhich may also contain question mark,space, double quote, or tab characters.
• FibreChannel: Any string 8-20 characterslong.
510 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
Name Type Notes
AuthenticationProtocol String
Specifies the authentication protocol to beused. SeeSupportedAuthenticationProtocols in List allresource types
CommunityString String
Specifies the new community string to beused. Valid values, by element type:
• Compute: Alphanumeric string 1-255characters long.
• Storage: Alphanumeric string 1 -180characters long. The characters ", \, ;, :, ,, *,?, <, >, |, /, ^, &, and% are invalid.
PrivacyPassword String
Specifies the new password to be usedwiththe privacy protocol. Valid values, byelement type:
• Ethernet: string containing 8-32characters. Can contain a question mark (?),white space( ), double quote(“), tab (\t)
• FibreChannel: string 8-20 characters long.
PrivacyProtocol StringSpecifies the privacy protocol to be used. SeeSupportedPrivacyProtocols in List allresource types
SnmpVersion String
Specifies the SNMP version to be used. Validvalues, by element type:
• Storage: V1
• Compute: V2c
• Ethernet: V3
• Fibre Channel: V3
UserName String
Specifies the new user name to be usedwiththe authentication and privacy protocol.Valid values, by element type:
• Ethernet: String containing 1-16characters. Can contain a question mark (?),white space, double quote(“)
• Fibre Channel: String value between 2 and32 characters long.
• Not used by Storage or Compute.
Chapter 2: UCP Director resources 511UCP Director API Reference
Monitoring resources
Response body
When the request is accepted a job is started and the body of the responsecontains a job object which can be also requested from GET UCP job.
Example: Update Ethernet SNMP configurationIn this example, the SNMP configurations are adjusted for Ethernetswitches.
Request HeaderPOSThttps://ucpmanagement.ucp.local/monitoring/resourceTypes/Ethernet/SnmpConfiguration HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"AuthenticationPassword":"authpassword","AuthenticationProtocol":"SHA1","CommunityString":null,"PrivacyPassword":"privpassword","PrivacyProtocol":"DES","SnmpVersion":"V3","UserName":"snmpuser"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Update SNMP Configurations".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get SNMP settings
This HTTP request uses the GET method on the /monitoring/resourcetypes/{RESOURCETYPE}/snmpConfiguration API where {RESOURCETYPE} iseither Storage, Compute, FibreChannel or Ethernet.
The body for this request must be empty.
The response body includes the following data. Note that passwords andcommunity strings are not returned.
512 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
Name Type Notes
AuthenticationProtocol String
The authentication protocol used by thespecified resource type. For FibreChanneland Ethernet, the options are: SHA1,MD5, or NoAuth. Server and Storage donot use authentication protocol.
PrivacyProtocol String
The privacy protocol used by the specifiedresource type. For FibreChannel andEthernet, options are: DES, AES128, orNoPriv. Server and Storage do not useprivacy protocol.
SnmpVersion StringThe version of SNMP protocol used by thespecified resource type.
UserName StringThis is the SNMP user name configuredinto V3 resource types.
Example: Get SNMP settings for Ethernet switches
In this example, the SNMP settings for Ethernet switches are returned withthe exception of passwords.
Request HeaderGEThttps://ucpmanagement.ucp.local/monitoring/resourceTypes/Ethernet/SnmpConfiguration HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"AuthenticationProtocol": "SHA1","PrivacyProtocol": "DES","SnmpVersion": "V3","UserName": "snmpuser"}
Get SNMP trap receiver
This HTTP request uses the GET method on thehttps://ucpmanagement.poda.local/monitoring/snmptrapreceiver URI.
Chapter 2: UCP Director resources 513UCP Director API Reference
Monitoring resources
The element managers for compute and storage (HCSM and HDvM) needthe trap receiver location input manually. This is done during UCP initialdeployment. If the IP and port are ever needed in the future, they can bereturned with this API. The SNMP trap receiver is within the UCPManagement VM.
Note that Ethernet and FibreChannel switches do not need manualconfiguration of the SNMP trap destination since UCP does thisautomatically on these elements.
The body for this request must be empty.
The response body contains the following properties.
Name Type Notes
Id String Id of the SNMP trap receiver.
ResourceType String ResourceType of the SNMP trap receiver.
GlobalResouceId StringGlobally unique resource Id for this SNMPtrap receiver.
InstanceId StringThe UCP instance Id containing this trapreceiver.
MonitorIpAddress StringIP address to use as the SNMP trapdestination when configuring elementmanagers to forward SNMP traps.
MonitorPortNumber StringPort number to use when configuring theSNMP trap destination in the elementmanager for Compute and Storage.
Example: Get IP and port to use for SNMP trap destination
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/snmptrapreceiver HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id":"0","ResourceType":"MonitorSettings","GlobalResourceId":"inst.UCP-123-456-789.mntrcfg","InstanceId":"UCP-123-456-789",
514 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"MonitorIpAddress":"10.21.19.243","MonitorPortNumber":162}
Refresh monitor states
This HTTP request uses the POST method on the/monitoring/monitorStates URI. The monitor state is a composite ofphysical health plus performance. Refreshing the monitor states causes UCPto do a fresh collection of health and performance information.
The body of this request must be empty.
When the request is accepted a job is started to refresh the monitor statesof all resource types. The body of the response contains a job object whichcan also be requested from the GET UCP job.
When the job is complete, the Get MonitorState by resource type API maybe executed again to display fresh results.
Example: Manually refresh monitor states
In this example, UCP does a fresh collection of data from which to derivenew monitor states. This executes a job and data is collected for all resourcetypes.
Request HeaderPOST https://ucpmanagement.ucp.local/monitoring/monitorStates HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Refresh health information for allelements".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Chapter 2: UCP Director resources 515UCP Director API Reference
Monitoring resources
Get monitor state for a resource type
This HTTP request uses the GET method on /monitoring/monitorStates or/monitoring/monitorStates?resourceType={RESOURCETYPE} URI, where{RESOURCETYPE} can be:
• Compute
• Ethernet
• FibreChannel
• Storage
Note that “monitor state” is a composite health status while “monitor mode”is a listening mode for SNMP messages.
Request body
The body for this request must be empty.
Response body
The response body contains monitor state data for all resources types or foronly the resource identified in the URI if one was specified. The collection ofdata for each resource type is the same as shown in List all resource types.
Example: Get monitor state for all Storage resources
In this example, the monitor state is requested for all storage resources.
Request HeaderGET
https://ucpmanagement.ucp.local/monitoring/monitorStates?resourceType=Storage HTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"GlobalResourceId": "inst.UCP-123-456-789.stor.1","MonitorIndicators": [{
516 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"DisplayName": "Storage Systems","IndicatorState": "Ok","IndicatorType": "Composite","Name": "StorageSystems","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.93040480"],"SubResourceType": "StorageSystem"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 101,"NumOks": 38,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "Storage","UpdatedDateTime": "12\/3\/2013 11:34:37 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480","MonitorIndicators": [{"DisplayName": "Cache Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "CachePerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Connection","IndicatorState": "Ok","IndicatorType": "Health","Name": "Connection","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Cache","IndicatorState": "Ok","IndicatorType": "Health","Name": "Cache","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Power Supply","IndicatorState": "Ok","IndicatorType": "Health","Name": "PowerSupply","SubGlobalResourceIds": null,
Chapter 2: UCP Director resources 517UCP Director API Reference
Monitoring resources
"SubResourceType": null},{"DisplayName": "Fan","IndicatorState": "Ok","IndicatorType": "Health","Name": "Fan","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "AC","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "AC","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Battery","IndicatorState": "Ok","IndicatorType": "Health","Name": "Battery","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Backup Battery","IndicatorState": "Ok","IndicatorType": "Health","Name": "BackupBattery","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Controller","IndicatorState": "Ok","IndicatorType": "Health","Name": "Controller","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Enclosure","IndicatorState": "Ok","IndicatorType": "Health","Name": "Enclosure","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Loop","IndicatorState": "NotApplicable",
518 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"IndicatorType": "Health","Name": "Loop","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "CTL Connector","IndicatorState": "Ok","IndicatorType": "Health","Name": "Connector","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Additional Battery","IndicatorState": "NotApplicable","IndicatorType": "Health","Name": "AdditionalBattery","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "I\/F Board","IndicatorState": "Ok","IndicatorType": "Health","Name": "IFBoard","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "CTL Fan","IndicatorState": "Ok","IndicatorType": "Health","Name": "CTLFan","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "IOM","IndicatorState": "Ok","IndicatorType": "Health","Name": "IOM","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Processors","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Processors","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.93040480.processor.ctl1-0","inst.UCP-123-456-789.stor.1.ss.93040480.processor.ctl0-1",
Chapter 2: UCP Director resources 519UCP Director API Reference
Monitoring resources
"inst.UCP-123-456-789.stor.1.ss.93040480.processor.ctl1-1","inst.UCP-123-456-789.stor.1.ss.93040480.processor.ctl0-0"],"SubResourceType": "StorageProcessor"},{"DisplayName": "Ports","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-C","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-H","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-E","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-D","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-G","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-F","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-C","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-H","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-D","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-E","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-F","inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-G"],"SubResourceType": "StoragePort"},{"DisplayName": "Pools","IndicatorState": "Ok","IndicatorType": "Composite","Name": "Pools","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.93040480.pool.2","inst.UCP-123-456-789.stor.1.ss.93040480.pool.1"],"SubResourceType": "StoragePool"},{"DisplayName": "Journals","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Journals","SubGlobalResourceIds": [
],"SubResourceType": "StorageJournal"},{"DisplayName": "Parity Groups","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "ParityGroups","SubGlobalResourceIds": [
520 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"inst.UCP-123-456-789.stor.1.ss.93040480.parityGroup.199","inst.UCP-123-456-789.stor.1.ss.93040480.parityGroup.198","inst.UCP-123-456-789.stor.1.ss.93040480.parityGroup.197"],"SubResourceType": "StorageParityGroup"},{"DisplayName": "Volumes","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Volumes","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.93040480.vol.46","inst.UCP-123-456-789.stor.1.ss.93040480.vol.26","inst.UCP-123-456-789.stor.1.ss.93040480.vol.36","inst.UCP-123-456-789.stor.1.ss.93040480.vol.16","inst.UCP-123-456-789.stor.1.ss.93040480.vol.41","inst.UCP-123-456-789.stor.1.ss.93040480.vol.51","inst.UCP-123-456-789.stor.1.ss.93040480.vol.21","inst.UCP-123-456-789.stor.1.ss.93040480.vol.31","inst.UCP-123-456-789.stor.1.ss.93040480.vol.11","inst.UCP-123-456-789.stor.1.ss.93040480.vol.45","inst.UCP-123-456-789.stor.1.ss.93040480.vol.25","inst.UCP-123-456-789.stor.1.ss.93040480.vol.35","inst.UCP-123-456-789.stor.1.ss.93040480.vol.15","inst.UCP-123-456-789.stor.1.ss.93040480.vol.44","inst.UCP-123-456-789.stor.1.ss.93040480.vol.24","inst.UCP-123-456-789.stor.1.ss.93040480.vol.34","inst.UCP-123-456-789.stor.1.ss.93040480.vol.14","inst.UCP-123-456-789.stor.1.ss.93040480.vol.8","inst.UCP-123-456-789.stor.1.ss.93040480.vol.9","inst.UCP-123-456-789.stor.1.ss.93040480.vol.6","inst.UCP-123-456-789.stor.1.ss.93040480.vol.7","inst.UCP-123-456-789.stor.1.ss.93040480.vol.4","inst.UCP-123-456-789.stor.1.ss.93040480.vol.5","inst.UCP-123-456-789.stor.1.ss.93040480.vol.88","inst.UCP-123-456-789.stor.1.ss.93040480.vol.98","inst.UCP-123-456-789.stor.1.ss.93040480.vol.48","inst.UCP-123-456-789.stor.1.ss.93040480.vol.28","inst.UCP-123-456-789.stor.1.ss.93040480.vol.38","inst.UCP-123-456-789.stor.1.ss.93040480.vol.18","inst.UCP-123-456-789.stor.1.ss.93040480.vol.40","inst.UCP-123-456-789.stor.1.ss.93040480.vol.50","inst.UCP-123-456-789.stor.1.ss.93040480.vol.20","inst.UCP-123-456-789.stor.1.ss.93040480.vol.30","inst.UCP-123-456-789.stor.1.ss.93040480.vol.10","inst.UCP-123-456-789.stor.1.ss.93040480.vol.93","inst.UCP-123-456-789.stor.1.ss.93040480.vol.43","inst.UCP-123-456-789.stor.1.ss.93040480.vol.23","inst.UCP-123-456-789.stor.1.ss.93040480.vol.33","inst.UCP-123-456-789.stor.1.ss.93040480.vol.13","inst.UCP-123-456-789.stor.1.ss.93040480.vol.97","inst.UCP-123-456-789.stor.1.ss.93040480.vol.49",
Chapter 2: UCP Director resources 521UCP Director API Reference
Monitoring resources
"inst.UCP-123-456-789.stor.1.ss.93040480.vol.47","inst.UCP-123-456-789.stor.1.ss.93040480.vol.42","inst.UCP-123-456-789.stor.1.ss.93040480.vol.29","inst.UCP-123-456-789.stor.1.ss.93040480.vol.27","inst.UCP-123-456-789.stor.1.ss.93040480.vol.22","inst.UCP-123-456-789.stor.1.ss.93040480.vol.39","inst.UCP-123-456-789.stor.1.ss.93040480.vol.37","inst.UCP-123-456-789.stor.1.ss.93040480.vol.32","inst.UCP-123-456-789.stor.1.ss.93040480.vol.19","inst.UCP-123-456-789.stor.1.ss.93040480.vol.17","inst.UCP-123-456-789.stor.1.ss.93040480.vol.12"],"SubResourceType": "StorageVolume"},{"DisplayName": "Physical Devices","IndicatorState": "Ok","IndicatorType": "Composite","Name": "PhysicalDevices","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.6","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.1","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.3","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.8","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.20","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.21","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.22","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.5","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.23","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.7","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.14","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.15","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.16","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.17","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.10","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.11","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.12","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.0","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.13","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.18","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.19","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.9","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.2","inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.4"],"SubResourceType": "StoragePhysicalDevice"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 101,"NumOks": 38,"NumUnknowns": 0,
522 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StorageSystem","UpdatedDateTime": "12\/3\/2013 11:34:37 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.46","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.26","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.36","MonitorIndicators": [{
Chapter 2: UCP Director resources 523UCP Director API Reference
Monitoring resources
"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.16","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.41","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report",
524 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.51","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.21","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},
Chapter 2: UCP Director resources 525UCP Director API Reference
Monitoring resources
{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.31","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.11","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.45","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,
526 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.25","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.35","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,
Chapter 2: UCP Director resources 527UCP Director API Reference
Monitoring resources
"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.15","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.44","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.24","MonitorIndicators": [{"DisplayName": "Volume Performance",
528 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.34","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.14","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,
Chapter 2: UCP Director resources 529UCP Director API Reference
Monitoring resources
"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.8","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.9","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{
530 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.6","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.7","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.4","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null
Chapter 2: UCP Director resources 531UCP Director API Reference
Monitoring resources
}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.5","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.88","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable",
532 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.98","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.48","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.28","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable",
Chapter 2: UCP Director resources 533UCP Director API Reference
Monitoring resources
"IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.38","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.18","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,
534 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.40","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.50","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.20",
Chapter 2: UCP Director resources 535UCP Director API Reference
Monitoring resources
"MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.30","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.10","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}
536 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.93","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.43","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume",
Chapter 2: UCP Director resources 537UCP Director API Reference
Monitoring resources
"UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.23","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.33","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.13","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance",
538 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.97","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.49","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,
Chapter 2: UCP Director resources 539UCP Director API Reference
Monitoring resources
"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.47","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.42","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.29","MonitorIndicators": [
540 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.27","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.22","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],
Chapter 2: UCP Director resources 541UCP Director API Reference
Monitoring resources
"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.39","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.37","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"
542 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.32","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.19","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.17","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance",
Chapter 2: UCP Director resources 543UCP Director API Reference
Monitoring resources
"SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.vol.12","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.6","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance",
544 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.1","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.3","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health",
Chapter 2: UCP Director resources 545UCP Director API Reference
Monitoring resources
"Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.8","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"
546 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.20","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.21","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],
Chapter 2: UCP Director resources 547UCP Director API Reference
Monitoring resources
"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.22","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.5","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},
548 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.23","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.7",
Chapter 2: UCP Director resources 549UCP Director API Reference
Monitoring resources
"MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.14","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,
550 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.15","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.16","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance",
Chapter 2: UCP Director resources 551UCP Director API Reference
Monitoring resources
"Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.17","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.10","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok",
552 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.11","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice",
Chapter 2: UCP Director resources 553UCP Director API Reference
Monitoring resources
"UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.12","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.0","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}
554 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.13","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.18","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null
Chapter 2: UCP Director resources 555UCP Director API Reference
Monitoring resources
},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.19","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{
556 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.9","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.2","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,
Chapter 2: UCP Director resources 557UCP Director API Reference
Monitoring resources
"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.physicalDevice.0.4","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-C","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report",
558 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-H","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-E","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort",
Chapter 2: UCP Director resources 559UCP Director API Reference
Monitoring resources
"UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-D","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-G","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-F","MonitorIndicators": [{
560 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL1-C","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-H","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}
Chapter 2: UCP Director resources 561UCP Director API Reference
Monitoring resources
],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-D","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-E","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,
562 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-F","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.port.CTL0-G","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.pool.2","MonitorIndicators": [
Chapter 2: UCP Director resources 563UCP Director API Reference
Monitoring resources
{"DisplayName": "Pool Usage","IndicatorState": "Ok","IndicatorType": "Health","Name": "PoolUsage","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Pool Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PoolPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePool","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.pool.1","MonitorIndicators": [{"DisplayName": "Pool Usage","IndicatorState": "Ok","IndicatorType": "Health","Name": "PoolUsage","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Pool Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PoolPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,
564 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"ResourceState": "Ok","ResourceType": "StoragePool","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.processor.ctl1-0","MonitorIndicators": [{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageProcessor","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.processor.ctl0-1","MonitorIndicators": [{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageProcessor","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.processor.ctl1-1",
Chapter 2: UCP Director resources 565UCP Director API Reference
Monitoring resources
"MonitorIndicators": [{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageProcessor","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.processor.ctl0-0","MonitorIndicators": [{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageProcessor","UpdatedDateTime": "12\/3\/2013 11:34:36 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.parityGroup.199","MonitorIndicators": [{"DisplayName": "Parity Group Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ParityGroupPerformance","SubGlobalResourceIds": null,
566 Chapter 2: UCP Director resources
UCP Director API Reference
Monitoring resources
"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageParityGroup","UpdatedDateTime": "12\/3\/2013 11:34:37 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.parityGroup.198","MonitorIndicators": [{"DisplayName": "Parity Group Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ParityGroupPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageParityGroup","UpdatedDateTime": "12\/3\/2013 11:34:37 PM +00:00"},{"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.93040480.parityGroup.197","MonitorIndicators": [{"DisplayName": "Parity Group Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ParityGroupPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,
Chapter 2: UCP Director resources 567UCP Director API Reference
Monitoring resources
"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageParityGroup","UpdatedDateTime": "12\/3\/2013 11:34:37 PM +00:00"}}
Performance Monitoring resourcesThe following Monitoring APIs enable the configuration of threshold values,SNMP settings, GET performance data, GET performance time filters andthe choice of aggregation type.
Request Method URI Privilege
"List aggregationfrequencies" on thefacing page
GET /monitoring/aggregationfrequencies UCP View
"Get performancecounter threshold" onpage 570
GET
/monitoring/ resourceTypes/{RESOURCETYPE}/PerformanceCounters/{PERFORMANCECOUNTERNAME}
UCP View
"Set performancecounter threshold" onpage 571
POST
/monitoring/ resourceTypes/{RESOURCETYPE}/PerformanceCounters/{ PERFORMANCECOUNTERNAME}
UCPAdministrator
"Get performance datafor a resource type" onpage 574
GET/monitoring/performance?resourceType={RESOURCETYPE}
UCP View
"Get performance datawith paging for aresource" on page 578
GET
/monitoring/performance?resourceType={RESOURCETYPE}&globalResourceId={GLOBALRESOURCEID}&performanceCounterNames={PERFORMANCECOUNTERNAMES}&offset={OFFSET}&pageSize={PAGESIZE}
UCP View
"Get multipleperformance countersfor multiple resouces"on page 580
GET
monitoring/performance?resourceType={RESOURCETYPE}&globalResourceId{GLOBALRESOURCEID}&performanceCounterNames={PERFCOUNTERNAME},{PERFCOUNTERNAME}
UCP View
568 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
Request Method URI Privilege
"Get historicalperformance of aresource" on page 581
GET
/monitoring/performance?resourceType={RESOURCETYPE}&globalResourceId={GLOBALRESOURCEID}&performanceCounterNames={PERFORMANCECOUNTERNAME}&fromTime={FROMTIME}&toTime={TOTIME}
UCP View
"Get performance databy aggregationfrequency" onpage 583
GET
/monitoring/performance?resourceType={RESOURCETYPE}&globalResourceId={GLOBALRESOURCEID}&performanceCounterNames={PERFORMANCECOUNTERNAMES}&aggregationFrequency={AGGREGATIONFREQUENCY}
UCP View
List aggregation frequencies
This API uses the GET method on the /monitoring/aggregationFrequenciesURI. It returns the frequency that health and performance data arecollected by UCP. The monitor states of resources are compiled from thisdata. The frequency of a performance counter collection schedule cannot bechanged, but it can be used in a filtered search.
The body for this request must be empty.
The response contains a list of potential values that can be used in a queryfor performance data by {AGGREGATIONFREQUENCY}. See the section forGet performance data by aggregation frequency.
Values returned are: ["30Minutes","2Hours","Daily","Weekly"]
Example: List aggregation frequencies
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/aggregationFrequenciesHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body["30Minutes",
Chapter 2: UCP Director resources 569UCP Director API Reference
Performance Monitoring resources
"2Hours","Daily","Weekly"}
Get performance counter threshold
This request uses the GET method on the /monitoring/resourceTypes/{RESOURCETYPE}/PerformanceCounters/{PERFORMANCECOUNTERNAME} API where a valid resource type isspecified in {RESOURCETYPE} and {PERFORMANCECOUNTERNAME}specifies a single performance counter related to the named resource type.
Get the list of resource types with their associated performance countersfrom the List all resource types API.
The body for this request must be empty.
The response body consists of the following data.
Name Type Notes
DisplayName StringDisplay name of the specificperformance counter
MetricUnit StringThe unit in which the performancecounter is measured
Name StringName of the performance counter,which may or may not be identical tothe display name.
PerformanceCounterThreshold CollectionCollection of data regarding theperformance counter
DampingHistory Int32Number of recent events the monitorwill keep in its memory
DampingThreshold Int32Number of times a specific event mustoccur in order to be treated as an event
IsThresholdEnabled BooleanDetermines whether the Thresholdfeature is in use or not
PerformanceCounterThresholdRules Collection Collection of condition value pairs.
Condition String
This is the threshold rule. Conditioncan be set to the following:
• TooLowError
• TooHighError
570 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
Name Type Notes
• TooLowWarning
• TooHighWarning
Value FloatThis is the threshold value. A valuemust be supplied alongwith anythreshold rule specified.
Example: Get Capacity of StoragePool
This example uses capacity as a performance counter of the StoragePoolresource type.
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/resourceTypes/StoragePool/PerformanceCounters/CapacityHTTP/1.1 Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"DisplayName": "Capacity","MetricUnit": "B","Name": "Capacity","PerformanceCounterThreshold": {"DampingHistory": 1,"DampingThreshold": 1,"IsThresholdEnabled": true,"PerformanceCounterThresholdRules": null}}
Set performance counter threshold
This HTTP request uses the POST method on the /monitoring/resourceTypes/{RESOURCETYPE}/PerformanceCounters/{PERFORMANCECOUNTERNAME} URI, where {RESOURCETYPE} specifiesthe resource type to be configured and performanceCounterName specifiesthe performance counter that thresholds are being set for.
Get the list of resource types with their associated performance countersfrom the List all resource types API.
Chapter 2: UCP Director resources 571UCP Director API Reference
Performance Monitoring resources
The following table lists the performance counter threshold settings thatcan be configured.
Name Type Notes
DampingHistory Int32Number of recent events the monitor willkeep in its memory
DampingThreshold Int32Number of times a specific event mustoccur in order to be treated as an event
IsThresholdEnabled BooleanDetermines whether the Thresholdfeature is in use or not
PerformanceCounterThresholdRules Collection Collection of condition value pairs.
Condition String
This is the threshold rule. Condition can beset to the following:
• TooLowError
• TooHighError
• TooLowWarning
• TooHighWarning
UCP expects a different value for eachcondition.
Sending an empty collection for thePerformanceCounterThresholdRule willundo any previous values, setting them tonothing.
Value FloatThis is the threshold value. A value mustbe supplied alongwith any threshold rulespecified.
Response body
When the request is accepted a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Set threshold levels on Ethernet Switch CPUUsage performancecounter
This example shows how to set the thresholds for the CPUUsageperformance counter for Ethernet switches.
572 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
Request HeaderPOSThttps://ucpmanagement.ucp.local/monitoring/resourceTypes/EthernetSwitch/PerformanceCounters/CPUUsage HTTP/1.1 Content-Type: application/json;charset=utf-8
Request Body{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":[{"Condition":"TooLowError","Value":1},{"Condition":"TooLowWarning","Value":3},{"Condition":"TooHighWarning","Value":75},{"Condition":"TooHighError","Value":85}]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Update a performance counter".
The properties for jobs can be viewed in Common response data under UCPDirector Resources
Example: Set threshold levels on StoragePool UsedPercentage performancecounter
This example shows how to set the thresholds for the UsedPercentageperformance counter for StoragePools. If any one of multiple pools reaches aone of these thresholds, the corresponding monitoring status will be set forthe storage resource as a whole.
Chapter 2: UCP Director resources 573UCP Director API Reference
Performance Monitoring resources
Request HeaderPOSThttps://ucpmanagement.ucp.local/monitoring/resourceTypes/StoragePool/PerformanceCounters/UsedPercentage HTTP/1.1 Content-Type:application/json; charset=utf-8
Request Body{"DampingHistory":1,"DampingThreshold":1,"IsThresholdEnabled":true,"PerformanceCounterThresholdRules":[{"Condition":"TooLowError","Value":1},{"Condition":"TooLowWarning","Value":3},{"Condition":"TooHighWarning","Value":75},{"Condition":"TooHighError","Value":85}]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Update a performance counter". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Get performance data for a resource type
This HTTP request uses the GET method on the/monitoring/performance?resourceType={RESOURCETYPE}&globalResourceId={GLOBALRESOURCEID}&performanceCounterNames={PERFORMANCECOUNTERNAMES} URI. The {RESOURCETYPE} can be anyvalid resource type. The {GLOBALRESOURCEID} specifies the uniqueglobal identifier of one resource. The {PERFORMANCECOUNTERNAMES}can be one or more performance counters separated by commas with nospaces. The unique global identifiers and performance counter names canbe found with the List all resource types API.
574 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
Valid resource types for this API are:
• EthernetSwitch
• EthernetSwitchPort
• FibreChannelSwitchPort
• StorageJournal
• StorageParityGroup
• StoragePool
• StoragePort
• StorageProcessor
• StorageSystem
• StorageVolume
To see a list of performance counters for each resource type, refer to "Listall resource types" on page 466.
Request body
The body for this request must be empty.
Response body
When the request succeeds, the response body consists of raw performancedata with the following properties.
Name Type Notes
DisplayName StringDisplay name of the specific performancecounter
MetricUnit StringThe unit in which the performancecounter is measured
Name StringName of the performance counter,which may or may not be identical to thedisplay name.
Chapter 2: UCP Director resources 575UCP Director API Reference
Performance Monitoring resources
Name Type Notes
PerformanceCounterThreshold CollectionCollection of data regarding theperformance counter
DampingHistory Int32Number of recent events the monitorwill keep in its memory
DampingThreshold Int32Number of times a specific event mustoccur in order to be treated as an event
IsThresholdEnabled BooleanDetermines whether the Thresholdfeature is in use or not
PerformanceCounterThresholdRules Collection Collection of condition value pairs.
Condition String
This is the threshold rule. Condition canbe set to the following:
• TooLowError
• TooHighError
• TooLowWarning
• TooHighWarning
Example: Get Performance Counter Data for Unallocated Space in theStorage System
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/performance?resourceType=StorageSystem&globalResourceId=inst.UCP-11111.stor.1.ss.310007&performanceCounterNames=UnallocatedSpace
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"GlobalResourceId": "inst.UCP-11111.stor.1.ss.310007","Offset": 0,"PerformanceCounterData":{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407947721000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace",
576 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
"Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407947994000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949242000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949515000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949794000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407950095000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},"ResourceType": "StorageSystem"
Chapter 2: UCP Director resources 577UCP Director API Reference
Performance Monitoring resources
}
Get performance data with paging for a resource
The HTTP request uses the GET method on the/monitoring/performance?resourceType={RESOURCETYPE}&globalResourceId={GLOBALRESOURCEID}&performanceCounterNames={PERFORMANCECOUNTERNAMES}&offset={OFFSET}&pageSize={PAGESIZE} URI.
An integer placed in the {PAGESIZE} variable limits the number of datapoints to just that quantity per page. The {OFFSET} variable is optionallyspecifies how many items to skip after the most recent one. For example, ifthere are 100 data points and the offset is 50, the displayed data will startat the fifty-first item. Also note that specifying a {GLOBALRESOURCEID}for a resource is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the performancedata for the specified resource Id, but will be limited to the number of datapoints specified in {PAGESIZE} and will start with the item after the{OFFSET} number, if specified.
The data returned by this URI have the same properties as shown in thesection called Get performance data for a resource type.
Example: Get Performance Data Counter for Unallocated Space in theStorage System with Offset 5 and Page Size 5
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/performance?resourceType=StorageSystem&globalResourceId=inst.UCP-11111.stor.1.ss.310007&performanceCounterNames=UnallocatedSpace&offset=5&pageSize=5
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"GlobalResourceId": "inst.UCP-11111.stor.1.ss.310007","Offset": 5,"PerformanceCounterData":{
578 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407947721000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407947994000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949242000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949515000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949794000)/","OffsetMinutes": 0},"PerformanceCounterName": "UnallocatedSpace","Value": 16633412368384},"ResourceType": "StorageSystem"}
Chapter 2: UCP Director resources 579UCP Director API Reference
Performance Monitoring resources
Get multiple performance counters for multiple resouces
This HTTP request uses the GET method on themonitoring/performance?resourceType={RESOURCETYPE}&globalResourceId={GLOBALRESOURCEID}&performanceCounterNames={PERFORMANCECOUNTERNAMES},{PERFORMANCECOUNTERNAMES}URI.
The body for this request must be empty.
When the request succeeds, the response body consists of raw performancedata. For an example of the data properties, see the section called Getperformance data for a resource type.
Example: Get multiple performance counters from multiple resources
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/performance?resourceType=StorageSystem&globalResourceId=inst.UCP-11111.stor.1.ss.310007&performanceCounterNames=ReservedSpace,FreeSpace
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"GlobalResourceId": "inst.UCP-11111.stor.1.ss.310007","Offset": 0,"PerformanceCounterData":{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407947721000)/","OffsetMinutes": 0},"PerformanceCounterName": "ReservedSpace","Value": 13943650672640},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407947994000)/","OffsetMinutes": 0},
580 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
"PerformanceCounterName": "FreeSpace","Value": 143563372363776},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949242000)/","OffsetMinutes": 0},"PerformanceCounterName": "FreeSpace","Value": 143563372363776},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949515000)/","OffsetMinutes": 0},"PerformanceCounterName": "ReservedSpace","Value": 13943650672640},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949794000)/","OffsetMinutes": 0},"PerformanceCounterName": "ReservedSpace","Value": 13943650672640},"ResourceType": "StorageSystem"}
Get historical performance of a resource
This HTTP request uses the GET method on the/monitoring/performance?resourceType={RESOURCETYPE}&globalResourceId={GLOBALRESOURCEID}&performanceCounterNames={PERFORMANCECOUNTERNAMES}&fromTime={FROMTIME}&toTime={TOTIME}&offset={OFFSET}&pageSize={PAGESIZE} URI, where{FROMTIME} and {TOTIME} are times between which the performancedata should be given.
The body for this request must be empty.
Chapter 2: UCP Director resources 581UCP Director API Reference
Performance Monitoring resources
The response body contains the requested performance counters and theirvalues. Properties of performance counters are explained under the headingGet performance data for a resource type.
Example: Get historical performance
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/performance?resourceType=StorageSystem&globalResourceId=inst.UCP-11111.stor.1.ss.310007&performanceCounterNames=ReservedSpace&fromTime=2014/08/01 08:01:01&toTime=2014/08/1012:02:02&offset=3&pageSize=5
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"GlobalResourceId": "inst.UCP-11111.stor.1.ss.310007","Offset": 3,"PerformanceCounterData":{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949515000)/","OffsetMinutes": 0},"PerformanceCounterName": "ReservedSpace","Value": 13943650672640},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407949794000)/","OffsetMinutes": 0},"PerformanceCounterName": "ReservedSpace","Value": 13943650672640},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407950095000)/","OffsetMinutes": 0},"PerformanceCounterName": "ReservedSpace",
582 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
"Value": 13943650672640},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407950394000)/","OffsetMinutes": 0},"PerformanceCounterName": "ReservedSpace","Value": 13943650672640},{"AggregationDataType": null,"DateTime":{"DateTime": "/Date(1407950693000)/","OffsetMinutes": 0},"PerformanceCounterName": "ReservedSpace","Value": 13943650672640},"ResourceType": "StorageSystem"}
Get performance data by aggregation frequency
The HTTP request uses the GET method on the/monitoring/performance?resourceType={RESOURCETYPE}&globalResourceId={GLOBALRESOURCEID}&performanceCounterNames={PERFORMANCECOUNTERNAMES}&aggregationFrequency={AGGREGATIONFREQUENCY} URI, where {AGGREGATIONFREQUENCY} isany of the aggregation frequencies which can also be requested from Listaggregation frequencies.
The body for this request must be empty.
The data returned by this URI have the same properties as shown in thesection called Get performance data for a resource type.
Example: Get performance data by aggregation frequency
Request HeaderGET https://ucpmanagement.ucp.local/monitoring/performance?resourceType=EthernetSwitch&globalResourceId=inst.UCP-11111.eth.1.net.2&performanceCounterNames=CPUUsage&aggregationFrequency=30Minutes
Request BodyThe body for this request must be empty.
Chapter 2: UCP Director resources 583UCP Director API Reference
Performance Monitoring resources
Response HeaderHTTP/1.1 200 OK
Response Body{"GlobalResourceId": "inst.UCP-11111.eth.1.net.2","Offset": 0,"PerformanceCounterData":{"AggregationDataType": AVG,"DateTime":{"DateTime": "/Date(1407947400000)/","OffsetMinutes": 0},"PerformanceCounterName": "CPUUsage","Value": 29},{"AggregationDataType": MAX,"DateTime":{"DateTime": "/Date(1407947400000)/","OffsetMinutes": 0},"PerformanceCounterName": "CPUUsage","Value": 61},{"AggregationDataType": MIN,"DateTime":{"DateTime": "/Date(1407947400000)/","OffsetMinutes": 0},"PerformanceCounterName": "CPUUsage","Value": 10},{"AggregationDataType": AVG,"DateTime":{"DateTime": "/Date(1407949200000)/","OffsetMinutes": 0},"PerformanceCounterName": "CPUUsage","Value": 8},{"AggregationDataType": MAX,"DateTime":{"DateTime": "/Date(1407949200000)/",
584 Chapter 2: UCP Director resources
UCP Director API Reference
Performance Monitoring resources
"OffsetMinutes": 0},"PerformanceCounterName": "CPUUsage","Value": 8},{"AggregationDataType": MIN,"DateTime":{"DateTime": "/Date(1407949200000)/","OffsetMinutes": 0},"PerformanceCounterName": "CPUUsage","Value": 8},"ResourceType": "EthernetSwitch"]
Scheduled job resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List scheduled jobs"below
GET /scheduler/scheduledjobs UCP View
"Get scheduled job" onthe next page
GET/scheduler/scheduledjobs/{jobtype}
UCP View
"Modify scheduled job" onpage 588
PUT/scheduler/scheduledjobs/{jobtype}
UCP ServerAdministration
List scheduled jobs
This HTTP request uses the GET method on the /scheduler/scheduledjobsURI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body returns an array for each scheduled job. Properties forscheduled jobs are detailed under the heading "Get scheduled job" on thenext page.
Chapter 2: UCP Director resources 585UCP Director API Reference
Scheduled job resources
Example: List scheduled jobs
Request HeaderGET https://ucpmanagement.ucp.local/scheduler/scheduledjobs HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"IntervalType": "Daily","IntervalValue": 30,"JobType": "ImageUpdate","RunAt": {"DateTime": "/Date(-2208729600000)/","OffsetMinutes": 0}}]
Get scheduled job
This HTTP request uses the GET method on the /scheduler/scheduledjobs/{JOBTYPE} URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following chart.
Name Type Notes
JobType StringIdentifies the scheduled job. Value:ImageUpdate
IntervalType StringThe type of interval to be used forscheduling. Values: Never, Daily, Weekly,or Monthly
IntervalValue Int32When to schedule the job to run again(based on IntervalType). Values depend onIntervalType:
586 Chapter 2: UCP Director resources
UCP Director API Reference
Scheduled job resources
Name Type Notes
• Never – Value is ignored
• Daily – Number of days to wait until nextrun (1-365, use 1 to run every day, 2 forevery other day, etc.)
• Weekly –1 for Sundays, 2 for Mondays,etc.
• Monthly –1 for the first day of themonth, 15 for the 15th day of the month(if greater than the number of days inmonth, run on last day of month)
RunAt CollectionCollection of the following two timingmetrics.
DateTime DateTimeThe date component is ignored, only timeof day is used.
OffsetMinutes Int32 Offset from UTC time.
Example: Get a scheduled job
Request HeaderGET https://ucpmanagement.ucp.local/scheduler/scheduledjobs/ImageUpdateHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"IntervalType": "Daily","IntervalValue": 30,"JobType": "ImageUpdate","RunAt": {"DateTime": "/Date(-2208729600000)/","OffsetMinutes": 0}}
Chapter 2: UCP Director resources 587UCP Director API Reference
Scheduled job resources
Modify scheduled job
This HTTP request uses the PUT method on the /scheduler/scheduledjobs/{JOBTYPE} URI, where {JOBTYPE} specifies the name of the scheduled UCPjob that is to be updated. The job type is case sensitive.
In vCenter, the UCP Server Administrator privilege is required.
This request body consists of the properties in the following chart.
Name Type Notes
IntervalType StringSpecifies the type of interval to be used forscheduling. Valid values: Never, Daily,Weekly, or Monthly
IntervalValue Int32
Specifies when to schedule the job to runagain (based on IntervalType). Valid valuesdepend on IntervalType:
• Never – Value is ignored
• Daily – Number of days to wait until nextrun (1-365, use 1 to run every day, 2 forevery other day, etc.)
• Weekly – Use 1 for Sundays, 2 forMondays, etc.
• Monthly – Use 1 for the first day of themonth, 15 for the 15th day of the month(if greater than the number of days inmonth, run on last day of month)
RunAt ObjectSpecifies the time of day the job will berun.
DateTime DateTimeTime of day for the scheduled job tolaunch. The date component is ignored,only time of day is used.
OffsetMinutes Int32 Offset from UTC time.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
588 Chapter 2: UCP Director resources
UCP Director API Reference
Scheduled job resources
Example: Modify the schedule for the update active images scheduled job
Request HeaderPUT https://ucpmanagement.ucp.local/scheduler/scheduledjobs/ImageUpdateHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"IntervalType": "Weekly","IntervalValue": 2,"RunAt": {"DateTime": "/Date(1347588000000)/","OffsetMinutes": 0}}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Set the schedule to check for updates toactive images".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Server resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List servers" on the nextpage
GET /api/servers UCP View
"Get server" on page 591 GET /api/servers/{SERVERID} UCP View
"Change server name" onpage 604
PUT /api/servers/{SERVERID}UCP ServerAdministrator
"Get the boot policy of aserver by its MAC" onpage 604
GET/api/servers/{SERVERMACADDRESS}/bootpolicy
UCP ServerAdministrator
"Deploy pending image toserver" on page 605
POST /api/servers/{SERVERID}/deployUCP ServerAdministrator
Chapter 2: UCP Director resources 589UCP Director API Reference
Server resources
Request Method URIvCenterPrivilege
"Get host networks" onpage 606
GET /api/servers/{SERVERID}/networksUCP NetworkAdministrator
"Apply host networkVLANs to Ethernetswitches" on page 608
POST/api/servers/{SERVERID}/networks/configurevlan
UCP NetworkAdministrator
"Create and attach volumeto host" on page 609
POST/api/servers/{SERVERID}/createandattachvolume
UCP StorageAdministrator
"Attach volume to host"on page 610
POST/api/servers/{SERVERID}/attachvolume
UCP StorageAdministrator
"Detach volume fromhost" on page 611
POST/api/servers/{SERVERID}/detachvolume
UCP StorageAdministrator
"Update server firmware"on page 612
POST/api/servers/{SERVERID}/firmwareupdates
UCP SystemAdministrator
"Set pending image forserver" on page 613
PUT /api/servers/{SERVERID}/imageUCP ServerAdministrator
"Turn on server LID" onpage 615
POST /api/servers/{SERVERID}/lidoffUCP ServerAdministrator
"Turn off server LID" onpage 614
POST /api/servers/{SERVERID}/lidonUCP ServerAdministrator
"Power off server" onpage 615
POST /api/servers/{SERVERID}/offUCP ServerAdministrator
"Reset server" onpage 616
POST /api/servers/{SERVERID}/resetUCP ServerAdministrator
"Power on server" onpage 617
POST /api/servers/{SERVERID}/onUCP ServerAdministrator
"Get server hierarchy" onpage 618
GET /api/servers/hierarchy UCP View
"List server images" onpage 621
GET /api/servers/images UCP View
"Get server image by Id"on page 656
GET /api/servers/images/{IMAGEID} UCP View
"Refresh server inventory"on page 658
POST /api/servers/refreshUCP ServerAdministrator
List servers
This HTTP request uses the GET method on the /api/servers URI.
In vCenter, the UCP View privilege is required.
590 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
The body for this request must be empty.
The response body contains an array of properties for each server in UCPinventory. Properties for servers are detailed under the heading "Getserver" below.
Example: List all servers
Request HeaderGET https://ucpmanagement.ucp.local/api/serversHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response BodyAll servers in UCP server inventory are returned. The management hostshosting the UCP management virtual machines are not returned.
To see an example of a server returned in a response body, see thesubheading "Example: Get a server" on page 599.
Get server
This HTTP request uses the GET method on the /api/servers/{SERVERID}URI, where {SERVERID} specifies the ID of the server that is to bereturned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
Name Type Notes
(Common properties) See Common properties.
MonitorState CollectionCollection of monitor stateinformation about this server.
MonitorIndicators Collection Array of monitor indicators.
Chapter 2: UCP Director resources 591UCP Director API Reference
Server resources
Name Type Notes
DisplayName StringName of indicator. User readablename
IndicatorState String
State of the indicator. Values:
• OK• Warning• Error• Unknown• NotApplicable
IndicatorType String
Type of the indicator. Values:
• Performance• Health• Composite
Name String Internal name for the indicator.
SubGlobalResourceIds String
Ids of sub resources related to server,if any. The health of sub resourcescontribute to the monitor state of theparent resource.
SubResourceType StringType of subresource related to theserver, if any.
MonitorMode String
SNMP reportingmode of all computeresources as a group. Values:
• Report
• Monitor
• Off
NumErrors Int32Number of errors totaled from theresource plus theSubGlobalResourceIds.
NumNotApplicables Int32Number of NAmessages totaled fromthe resource plusSubGlobalResourceIds.
NumOks Int32Number of OKmessages totaled fromthe resource plus theSubGlobalResourceIds.
NumUnknowns Int32Number of Unknown messagestotaled from the resource plus theSubGlobalResourceIds.
592 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Name Type Notes
NumWarnings Int32Number of Warnings totaled from theresource plus theSubGlobalResourceIds.
ResourceState String
Overall monitor state of the server.Values:
• OK
• Warning
• Error
• Unknown
ResourceType StringType of resource. Always “Server” forserver.
UpdatedDateTime DateTimeLast time the server was polled formonitor state.
HostInformation CollectionCollection of metadata about thehost.
ApplyingTemplate BooleanWhether the server is applying atemplate.
ClusterId String The ID of the cluster.
ClusterName String The name of the cluster.
CurrentImageId Int32The ID of the current image on theserver.
CurrentImageName StringThe name of the current image on theserver.
CurrentImageType StringType of boot image associated withthe host.
HostId String The ID of the host.
HostName String The name of the host.
HostUuid String The UUID of the host.
InMaintenanceMode BooleanWhether or not the server is inmaintenance mode.
ServerDeploymentInformation Collection Collection of deployment information.
DefaultImageId Int32The ID of the default ESXi image forthe server.
DefaultImageName StringThe name of the default ESXi imagefor this server if it is an ESXi host.
Chapter 2: UCP Director resources 593UCP Director API Reference
Server resources
Name Type Notes
IsLocked BooleanWhether or not the server is locked.Reserved for future use.
PendingImageId Int32The ID of ESXi image that will bedeployed to the server next time itreboots.
PendingImageName StringThe name of the ESXi image that willbe deployed to the server next time itreboots.
Uuid String The UUID of the server.
ServerInformation Collection Collection about the server hardware.
AvailableFirmwareVersion StringFirmware available from UCP forupdating this server.
BmcDefaultGateway StringThe default gateway for the BMC(BaseboardManagement Controller).
BmcDhcpEnabled BooleanWhether or not DHCP is enabled forBMC network configuration.
BmcFirmwareVersionCurrent String The current version of BMC firmware.
BmcFirmwareVersionPending String The pending version of BMC firmware.
BmcIp String The IP address of the BMC.
BmcSubnetMask String The subnet mask of the BMC.
BootType StringThe boot type for the server.ESXiStateless, Custom, or HyperV.
ChassisId StringThe ID of the chassis where theserver is installed.
ChassisSerialNumber StringThe serial number of the chassiswhere the server is installed.
ConsoleUri String
The URL to use to connect to theremote console of the server.Requires UCP Server Console AccessPrivilege.
CoresPerCPU Int32The number of cores in eachprocesser.
CpuCacheSize StringThe size of the CPU cache, expressedas text.
CpuCacheSizeInMB Int32The size of the CPU cache inmegabytes.
CpuFrequency StringThe clock frequency of the CPU,expressed as text.
594 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Name Type Notes
CpuFrequencyInGHz Int32The clock frequency of the CPU ingigahertz.
CpuType String The model name of the CPU.
CurrentFirmwareVersion StringFirmware version currently used bythe server.
CurrentServerProfileId StringID of the server profile currently usedby the server.
EfiFirmwareVersionCurrent StringThe current version of EFI firmware.(Extensible Firmware Interface, a.k.a.BIOS)
EfiFirmwareVersionPending String The pending version of EFI firmware.
ErrorCount Int32The number of unconfirmed errormessages.
HardwareMaintenanceMode Boolean
If the server is in maintenance mode.This is from the chassis perspective,usedwhen server is undergoingfirmware upgrade.
HbaInformationList CollectionCollection of metadata regarding theHBA in the server. This block of data isrepeated once for each HBA port.
CardName String The detailed name of the HBA.
CardSlot Int32The slot number in the server wherethe HBA is installed.
CardType String The HBAmodel name.
DeviceId String The PCI device Id of the HBA.
FunctionNumber Int32The function number of the HBA onthe PCI bus.
Model String The simple model name.
PortNumber Int32 The HBA port number.
ServerBladeNumber Int32The chassis slot number of the serverto which the HBA belongs.
WorldWideNodeName String WorldWide Node Name of the HBA.
WorldWideNodeNameChangeFromDefault Boolean Reserved for future use. Always false.
WorldWideNodeNameDuplication Boolean Reserved for future use. Always false.
WorldWidePortName String WorldWide Port Name of the HBA.
WorldWidePortNameChangeFromDefault Boolean Reserved for future use. Always false.
WorldWidePortNameDuplication Boolean Reserved for future use. Always false.
Chapter 2: UCP Director resources 595UCP Director API Reference
Server resources
Name Type Notes
Health String
The health status of the server.Values:
• Healthy
• Warning
• Critical
• Unknown
InformationCount Int32The number of unconfirmedinformation messages.
LIDColor String
The color of the LID on the front ofthe server. (Location IndicatingDiode).
Values:
• Blue
• Unknown
LIDState String
The state of the LID on the front ofthe server.
Values:
• On
• Off
• Unknown
LastRefreshed DateTimeThe date and time server elementmanager information was lastrefreshed.
MacType String
Indicates chassis virtualization of theMAC address.
Values:
• Additional
• Original
• Unknown
596 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Name Type Notes
For proper function of this serverwithin UCP, the value must be kept at“Additional”.
Manufacturer StringThe name of the servermanufacturer.
MemoryAmount StringThe total size of memory in theserver, expressed as text.
MemoryAmountInGB Int32The total size of memory in the serverin gigabytes.
Model String The server model name.
ModelNumber String The server model number.
NicInformationList Collection
Collection of NIC details for the server.(Network Interface Card). Thiscollection is repeated for each NICport.
CardName String The detailed name of the NIC.
CardSlot Int32The slot number in the server wherethe NIC is installed.
CardType String Whether embedded or an add-in card.
ChangedFromDefault Boolean Reserved for future use. Always false.
ControllerNumber Int32
Controller number on the networkadapter. When UCP supports 4 portCNA, there will be two controllers onone adapter.
DeviceId String The PCI device Id of the NIC.
Duplication Boolean Reserved for future use. Always false.
FunctionNumber Int32The PCI function number of the NICchannel\port.
MacAddress StringThe MAC address of the NICchannel\port.
Model String The simple model name.
PhysicalPortNumber Int32 The port number on the physical NIC.
PortNumber Int32
If the CNA is partitioned, this is thevirtual port number on the abovephysical port. If not partitioned, thisnumber is the same as the abovePhysicalPortNumber.
Chapter 2: UCP Director resources 597UCP Director API Reference
Server resources
Name Type Notes
ServerBladeNumber Int32The chassis slot number of the bladeto which the NIC belongs.
NumberOfCPUs Int32The number of CPUs in the blade.(Physical processor sockets).
OperatingMode String
HVMmode enables logical partitioning(LPAR) of physical blade resouces.
Values:• HVM• Basic• Unknown
PartitionNumber Int32Partition number of blade. Refer toHCSM document for an explanation ofpartitions.
PartitionValid Boolean Partition validation status.
PartitionWidth Int32 The width of partition.
PendingFirmwareVersion StringPending firmware version available tobe usedwhen upgrading.
PowerState String
The state of blade power.
Values:
• On
• Off
• Unknown
PrimarySlot Int32The chassis slot number where theblade is installed.
SerialNumber String The server serial number.
ServerId StringThe ID of the server. Use this ID inother requests to specify this server.
ServerUuid String The UUID of the server.
UuidType String
Type of UUID, if virtualized or not. Ifserver has applied a server profile, theUuidType will be “Additional”. If not, itis “Original”.
WarningCount Int32The number of unconfirmedwarningmessages.
598 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Name Type Notes
WwnType String
Whether the chassis uses the burned-in WWN from the HBA or hasabstracted it into a virtual identity.
Values:
• Additional
• Original
• Unknown
For proper function of this serverwithin UCP, the value must be kept at“Additional”.
Example: Get a server
In this example, a specific server is requested in the URI.
Request HeaderGET https://ucpmanagement.ucp.local/api/servers/8f9d7939-a10b-4a9e-a4c4-9e5e0e721111HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body
{"Id": "8f9d7939-a10b-4a9e-a4c4-9e5e0e721111","ResourceType": "Server","GlobalResourceId": "inst.v2ProductionE-123-456-789.cmp.1.ser.8f9d7939-a10b-4a9e-a4c4-9e5e0e721111","InstanceId": "v2ProductionE-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.pode.local\/api\/servers\/8f9d7939-a10b-4a9e-a4c4-9e5e0e721111"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.pode.local\/api\/servers"},
Chapter 2: UCP Director resources 599UCP Director API Reference
Server resources
{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Server&targetId=inst.v2ProductionE-123-456-789.cmp.1.ser.8f9d7939-a10b-4a9e-a4c4-9e5e0e721111&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Server&targetId=inst.v2ProductionE-123-456-789.cmp.1.ser.8f9d7939-a10b-4a9e-a4c4-9e5e0e721111&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Server&targetId=inst.v2ProductionE-123-456-789.cmp.1.ser.8f9d7939-a10b-4a9e-a4c4-9e5e0e721111&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Server&targetId=inst.v2ProductionE-123-456-789.cmp.1.ser.8f9d7939-a10b-4a9e-a4c4-9e5e0e721111&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Server&targetId=inst.v2ProductionE-123-456-789.cmp.1.ser.8f9d7939-a10b-4a9e-a4c4-9e5e0e721111&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Server&targetId=inst.v2ProductionE-123-456-789.cmp.1.ser.8f9d7939-a10b-4a9e-a4c4-9e5e0e721111&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2ProductionE-123-456-789.cmp.1.ser.8f9d7939-a10b-4a9e-a4c4-9e5e0e721111","MonitorIndicators": [{"DisplayName": "Server Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "ServerHealth",
600 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 0,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "Server","UpdatedDateTime": "4\/27\/2015 7:35:44 PM +00:00"},"HostInformation": {"ApplyingTemplate": false,"ClusterId": "domain-c246","ClusterName": "TestCluster","CurrentImageId": 4,"CurrentImageName": "HitachiESXiImage-55U2-20150313-520HB3","CurrentImageType": "EsxiStateless","HostId": "host-242","HostName": "10.21.67.101","HostUuid": "8f9d7939-a10b-4a9e-a4c4-9e5e0e721111","InMaintenanceMode": true},"ServerDeploymentInformation": {"DefaultImageId": 4,"DefaultImageName": "HitachiESXiImage-55U2-20150313-520HB3","IsLocked": true,"PendingImageId": 4,"PendingImageName": "HitachiESXiImage-55U2-20150313-520HB3","Uuid": "8f9d7939-a10b-4a9e-a4c4-9e5e0e721111"},"ServerInformation": {"AvailableFirmwareVersion": null,"BmcDefaultGateway": "10.21.67.1","BmcDhcpEnabled": false,"BmcFirmwareVersionCurrent": "08-27","BmcFirmwareVersionPending": "","BmcIp": "10.21.67.12","BmcSubnetMask": "255.255.255.0","BootType": "ESXiStateless","ChassisId": "Hitachi_0_323GG-RE3A1NBX1-Y00000009","ChassisSerialNumber": "323GG-RE3A1NBX1-Y00000009","ConsoleUri": "https:\/\/10.21.67.12\/","CoresPerCPU": 12,"CpuCacheSize": "30 MB","CpuCacheSizeInMB": 30,"CpuFrequency": "2.6 GHz","CpuFrequencyInGHz": 2.6,"CpuType": "Intel(R) Xeon(R) CPU E5-2690 v3 @ 2.60GHz","CurrentFirmwareVersion": "08-29",
Chapter 2: UCP Director resources 601UCP Director API Reference
Server resources
"CurrentServerProfileId": "100","EfiFirmwareVersionCurrent": "08-29","EfiFirmwareVersionPending": "","ErrorCount": 0,"HardwareMaintenanceMode": "FALSE","HbaInformationList": [{"CardName": "Hitachi 8Gb 2-port fibre channel mezzanine card","CardSlot": 2,"CardType": "MEZZANINE","DeviceId": "0B00","FunctionNumber": 1,"Model": "MEZZANINE","PortNumber": 1,"ServerBladeNumber": 1,"WorldWideNodeName": "24:00:D0:5F:CE:51:00:52","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:51:00:53","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false},{"CardName": "Hitachi 8Gb 2-port fibre channel mezzanine card","CardSlot": 2,"CardType": "MEZZANINE","DeviceId": "0B00","FunctionNumber": 0,"Model": "MEZZANINE","PortNumber": 0,"ServerBladeNumber": 1,"WorldWideNodeName": "24:00:D0:5F:CE:51:00:50","WorldWideNodeNameChangeFromDefault": false,"WorldWideNodeNameDuplication": false,"WorldWidePortName": "24:00:D0:5F:CE:51:00:51","WorldWidePortNameChangeFromDefault": false,"WorldWidePortNameDuplication": false}],"Health": "Healthy","InformationCount": 178,"LIDColor": "Blue","LIDState": "Off","LastRefreshed": "\/Date(1430163165000-0700)\/","MacType": "Additional","Manufacturer": "HITACHI","MemoryAmount": "32 GB","MemoryAmountInGB": 32,"Model": "Compute Blade 520HB3","ModelNumber": "GG-RV3XGC0B3X1-Y","NicInformationList": [{"CardName": "10Gb Onboard LAN",
602 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0100","Duplication": false,"FunctionNumber": 1,"MacAddress": "d0:5f:ce:51:00:35","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 1,"ServerBladeNumber": 1},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0100","Duplication": false,"FunctionNumber": 3,"MacAddress": "d0:5f:ce:51:00:37","Model": "ONBOARD","PhysicalPortNumber": 1,"PortNumber": 3,"ServerBladeNumber": 1},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0100","Duplication": false,"FunctionNumber": 0,"MacAddress": "d0:5f:ce:51:00:34","Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 0,"ServerBladeNumber": 1},{"CardName": "10Gb Onboard LAN","CardSlot": 1,"CardType": "ONBOARD","ChangedFromDefault": false,"ControllerNumber": 0,"DeviceId": "0100","Duplication": false,"FunctionNumber": 2,"MacAddress": "d0:5f:ce:51:00:36",
Chapter 2: UCP Director resources 603UCP Director API Reference
Server resources
"Model": "ONBOARD","PhysicalPortNumber": 0,"PortNumber": 2,"ServerBladeNumber": 1}],"NumberOfCpus": 2,"OperatingMode": "Basic","PartitionNumber": 1,"PartitionValid": true,"PartitionWidth": 1,"PendingFirmwareVersion": "","PowerState": "On","PrimarySlot": 1,"SerialNumber": "323GG-RV3XGC0B3X1-Y00000187","ServerId": "8f9d7939-a10b-4a9e-a4c4-9e5e0e721111","ServerUuid": "8f9d7939-a10b-4a9e-a4c4-9e5e0e721111","UuidType": "Additional","WarningCount": 1,"WwnType": "Additional"}}
Change server name
This API has been deprecated.
Host names for ESXi and for Linux and Windows hosts are now configuredduring UCP service template application. Now UCP checks the DNS a-recordsfor a host name with an IP that matches the one from the server profile. Ifan a-record is found, the host undergoing deployment will be configuredwith that host name. Otherwise a randomly generated host name will beused for Linux and Windows or, if the host is ESXi, the IP address will beuse.
Get the boot policy of a server by its MAC
This HTTP request uses the GET method on the URI: /api/servers/{MACADDRESS}/bootpolicy.
The bootpolicy dictates whether or not vSphere’s Auto Deploy will respondto PXE requests from this MAC address and deploy ESXi to the server. Inthe URI, the MAC address must be formatted with dashes, for example:https://ucpmanagement.ucp.local/api/servers/00-1f-67-13-04-3c/bootpolicy.
The body for this request must be empty.
604 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
The response body contains a string value designating whether or not ESXiwill be deployed to the server the next time it reboots
Example: Get boot policy of a server in Custom boot type
This server, identified by its MAC address in the URI will not receive an ESXiimage the next time it reboots. The server likely runs Windows or Linux.
Request HeaderGET https://ucpmanagement.ucp.local/api/servers/d0-5f-ce-01-01-80/bootpolicyHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body"#!ipxe\u000d\u000aset custom 1\u000d\u000achain tftp:\/\/${next-server}\/ucptramp"
Example: Get boot policy of a server in Custom boot type
This server, identified by its MAC address in the URI, will receive an ESXiimage from vSphere Auto Deploy the next time it boots.
Request HeaderGET https://ucpmanagement.ucp.local/api/servers/d0-5f-ce-01-01-01/bootpolicyHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body"#!ipxe\u000d\u000aset autodeploy 1\u000d\u000achain tftp:\/\/${next-server}\/ucptramp"
Deploy pending image to server
This HTTP request uses the POST method on the /api/servers/{SERVERID}/deploy URI, where {SERVERID} specifies the ID of the server that has apending ESXi image to be deployed. This applies only to servers using the
Chapter 2: UCP Director resources 605UCP Director API Reference
Server resources
boot type of ESXiStateless.
In vCenter, the UCP Server Administrator privilege is required.
This request body requires the Force parameter with a supplied value oftrue or false.
Name Type Notes
Force Boolean
When the value is true, the server will berebooted even if it is not in maintenancemode.When false, the server will only berebooted if it is in maintenance mode.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Deploy a pending image to a serverRequest HeaderPOST https://ucpmanagementucp.local/api/servers/6e37f410-b4a7-11e1-94b0-c6aca3093fbb/deployHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"Force": false}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Deploy image to server".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Get host networks
This HTTP request uses the GET method on the /api/servers/{SERVERID}/networks URI, where {SERVERID} specifies the ID of the server with thehost network uplink configuration that is to be returned.
In vCenter, the UCP View privilege is required.
606 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
The body for this request must be empty.
The response body contains an array of information for each connected hostuplink. Host uplink arrays contain the properties in the following chart.
Name Type Notes
ConnectedEthernetSwitchPort CollectionCollection of the following threeproperties.
NativeVlanId StringTags and untags incoming and outgoingtraffic, respectively, to receive and sendinformation.
PortId StringId of the Ethernet switch port that theserver network uplink is connected tophysically.
SwitchId String Id of the connected Ethernet switch.
Vlans StringThe comma separated list of VLANscurrently used by the connected switchport.
Name String The name of the host uplink.
Vlans StringThe comma separated list of VLANs onthe host uplink.
WhatIfConfiguredSwitchPortVlans StringThe VLANs that would be set on thephysical Ethernet switch port ifconfigured by UCP Director.
Example: Get a host's network uplink configurations
In this example, the server has two network uplinks connected to the virtualswitch.
Request HeaderGET https://ucpmanagement.ucp.local/api/servers/6e37f410-b4a7-11e1-94b0-c6aca3093fbb/networksHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"ConnectedEthernetSwitchPort": {
Chapter 2: UCP Director resources 607UCP Director API Reference
Server resources
"PortId": "TenGigabitEthernet 0/12","SwitchId": "3","Vlans": "475-477,482,521"},"Name": "vmnic0","Vlans": "475-477,482,521","WhatIfConfiguredSwitchPortVlans": "475-477,482,521"},{"ConnectedEthernetSwitchPort": {"PortId": "TenGigabitEthernet 0/12","SwitchId": "4","Vlans": "475-477,482,521"},"Name": "vmnic1","Vlans": "475-477,482,521","WhatIfConfiguredSwitchPortVlans": "475-477,482,521"}]
Apply host network VLANs to Ethernet switches
This HTTP request uses the POST method on the /api/servers/{SERVERID}/networks/configurevlan URI.
UCP collects the VLANs used by virtual switches connected to the specifiedhost and applies them to the physical Ethernet switch ports used by thehost. For servers running Windows, Linux, or Custom operating systems,the VLAN IDs from the API payload will be applied to the servers’ connectedEthernet switch ports.
In vCenter, the UCP Network Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Apply a host's VLANs to the Ethernet switches it usesRequest HeaderPOST https://ucpmanagement.ucp.local/api/servers/6e37f410-b4a7-11e1-94b0-c6aca3093fbb/networks/configurevlanHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
608 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Configure Ethernet switch VLAN settingsbased on a host". The properties for jobs can be viewed in Commonresponse data under UCP Director Resources.
Create and attach volume to host
This HTTP request uses the POST method on the /api/servers/{SERVERID}/createandattachvolume URI, where {SERVERID} specifies the ID of theserver to which the volume is to be attached.
In vCenter, the UCP Storage Administrator privilege is required
This request body consists of the properties in the following chart.
Name Type Notes
PoolId StringSpecifies the ID of the storage pool that isto contain the new volume.
VolumeSizeInBytes FloatSpecifies the size of the new volume. Validrange: 1288490188 – 65970693734400bytes (1.12 GB – 59.99 TB).
ShouldFormat Boolean
Applicable only when the target host isESXi. Specifies whether the volume is tobe formatted. The format used is VMFS.When true, VolumeName is required.
StorageSystemId StringSpecifies the ID of the storage system thatis to contain the new volume.
StorageSystemPortIdsArray ofStrings
Optionally specifies four IDs of storageports to be used for volume paths. If notspecified, UCP will select ports with thefewest paths. There must be one odd andone even port for each fabric.
VolumeName StringSpecifies the name of the new datastore.Required when FormatVolume is true.Applicable only when target host is ESXi.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Chapter 2: UCP Director resources 609UCP Director API Reference
Server resources
Example: Create and attach a new volume to a hostRequest HeaderPOST https://ucpmanagement.ucp.local/api/servers/ a87788f9-9093-11e1-a6a5-a0c2cccb9995/createandattachvolumeHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"PoolId": "3","VolumeSizeInBytes": 53687091200,"ShouldFormat": true,"StorageSystemId": "53106","StorageSystemPortIds": null,"VolumeName": "HRWeb"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Create a new volume and attach it to ahost". The properties for jobs can be viewed in Common response dataunder UCP Director Resources.
Attach volume to host
This HTTP request uses the POST method on the /api/servers/{SERVERID}/attachvolume URI, where {SERVERID} specifies the ID of the server towhich the volume is to be attached.
If it is a boot volume, it cannot be attached to other hosts.
In vCenter, the UCP Storage Administrator privilege is required
This request body consists of the properties in the following chart.
Name Type Notes
StorageSystemId StringSpecifies the ID of the storage systemcontaining the volume to be attached
VolumeId StringSpecifies the ID of the volume that is to beattached
StorageSystemPortIdsArray ofStrings
Optionally specifies the SAN ports throughwith the host should address the volume.When not specified by the user, UCPselects the best ports based on usage
610 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Attach a volume to a hostRequest HeaderPOST https://ucpmanagement.ucp.local/api/servers/a87788f9-9093-11e1-a6a5-a0c2cccb9995/attachvolumeHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body[{"StorageSystemId": "93040480","VolumeId": "24","StorageSystemPortIds": null}]
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Attach an existing volume to a host".The properties for jobs can be viewed in Common response data under UCPDirector Resources.
Detach volume from host
This HTTP request uses the POST method on the /api/servers/{SERVERID}/detachvolume URI, where {SERVERID} specifies the ID of the server fromwhich the volume is to be detached.
In vCenter, the volume must first be "unmounted" from the host.
In SCVMM, Hyper-V hosts must be powered on before the data-volumes canbe detached, but must be powered off before attaching the boot volume.
In either platform, non-hypervisor hosts must be powered off beforevolumes can be detached.
In vCenter, the UCP Storage Administrator privilege is required
This request body consists of the properties in the following chart.
Chapter 2: UCP Director resources 611UCP Director API Reference
Server resources
Name Type Notes
StorageSystemId StringSpecifies the ID of the storage systemcontaining the volume to be detached.
VolumeId StringSpecifies the ID of the volume that is to bedetached.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Detach a volume from a hostRequest HeaderPOST https://ucpmanagement.ucp.local/api/servers/ a87788f9-9093-11e1-a6a5-a0c2cccb9995/detachvolumeHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"StorageSystemId": "53106","VolumeId": "14849"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Detach a volume from a host".
The properties for jobs can be viewed in Common response data under UCPDirector Resources
Update server firmware
The HTTP request uses the POST method on the following URI:/api/servers/{SERVERID}/firmwareupdates.
The API will apply the pending firmware to the server named in the URI.UCP contains only one version of firmware for all server blades. Firmwarebundle for blades consists of EFI and BMC. If the version of the firmwarebundle is different from what the server currently uses, the server willreboot and apply the pending firmware (which may be newer or older).
The request body must be empty.
In vCenter, the UCP Server Administrator privilege is required.
612 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Update server firmware
Request HeaderPOST https://ucpmanagement.ucp.local/api/servers/203a16a5-0625-11e2-81d1-8afca799b9f3/firmwareupdatesHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Update server firmware".
The properties for jobs can be viewed in Common response data under UCPDirector Resources
Set pending image for server
This HTTP request uses the PUT method on the /api/servers/{SERVERID}/image URI, where {SERVERID} specifies the ID of the server that is to beassigned a pending ESXi image.
This function applies only to ESXi images.
In vCenter, the UCP Server Administrator privilege is required.
This request body consists of the properties in the following chart.
Name Type Notes
ImageId String
Specifies the image ID that is to be thepending image for the server. If empty, thepending image will be the default image forthe server type.
Response body
Chapter 2: UCP Director resources 613UCP Director API Reference
Server resources
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Set a pending image for a specific server
Request HeaderPUT https://ucpmanagement.ucp.local/api/servers/c78de152-8fcc-11e1-97f8-9025f430fc6d/image HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"ImageId": "18"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Assign pending image to a server". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Turn off server LID
This HTTP request uses the POST method on the /api/servers/{SERVERID}/lidoff URI, where {SERVERID} specifies the ID of the server with thelocation ID that is to be turned off.
In vCenter, the UCP Server Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Turn off a server’s LID
Request HeaderPOST https://ucpmanagement.ucp.local/api/servers/420904c6-8fe8-11e1-b8a6-f3397e44dc5d/lidoffHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
614 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Turn off server LID". The properties forjobs can be viewed in Common response data under UCP DirectorResources.
Turn on server LID
This HTTP request uses the POST method on the /api/servers/{SERVERID}/lidon URI, where {SERVERID} specifies the ID of the server with thelocation ID that is to be turned on.
In vCenter, the UCP Server Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Turn on a server’s LID
Request HeaderPOST https://ucpmanagement.ucp.local/api/servers/420904c6-8fe8-11e1-b8a6-f3397e44dc5d /lidon HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Turn on server LID". The properties forjobs can be viewed in Common response data under UCP DirectorResources.
Power off server
This HTTP request uses the POST method on the /api/servers/{SERVERID}/off URI, where {SERVERID} specifies the ID of the server that is to bepowered off.
In vCenter, the UCP Server Administrator privilege is required.
Chapter 2: UCP Director resources 615UCP Director API Reference
Server resources
This request body consists of the properties in the following chart.
Name Type Notes
Force Boolean
Optionally specifies that the server shouldbe powered off even if it is not inmaintenance mode. Defaults to False. Mustbe True to override the check.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Power off a server
Request HeaderPOST https://ucpmanagement.ucp.local/api/servers/a87788f9-9093-11e1-a6a5-a0c2cccb9995/off HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"Force": false}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Power off server". The properties for jobscan be viewed in Common response data under UCP Director Resources.
Reset server
This HTTP request uses the POST method on the /api/servers/{SERVERID}/reset URI, where {SERVERID} specifies the ID of the server that is to bereset.
In vCenter, the UCP Server Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
Force Boolean
Optionally specifies that the server shouldbe reset even if it is not in maintenancemode. Defaults to False. Must be True tooverride the check.
616 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Reset a server
The ‘force’ flag will ignore when the host is not in maintenance mode.
Request HeaderPOST https://ucpmanagement.ucp.local/api/servers/6e37f410-b4a7-11e1-94b0-c6aca3093fbb/reset HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"Force": true}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Reset server". The properties for jobscan be viewed in Common response data under UCP Director Resources.
Power on server
This HTTP request uses the POST method on the /api/servers/{SERVERID}/on URI, where {SERVERID} specifies the ID of the server that is to bepowered on.
In vCenter, the UCP Server Administrator privilege is required.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Power on a server
Request HeaderPOST https://ucpmanagement.ucp.local/api/servers/a87788f9-9093-11e1-a6a5-a0c2cccb9995/on HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Chapter 2: UCP Director resources 617UCP Director API Reference
Server resources
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Power on server". The properties for jobscan be viewed in Common response data under UCP Director Resources.
Get server hierarchy
This HTTP request uses the GET method on the /api/servers/hierarchy URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of an array ofobjects containing the properties detailed in the following table.
Name Type Notes
Id StringThe ID of a server or one of its parentcontainers.
Name String The name of a server or one of its parents.
ParentId StringThe ID of one of the parent containers for aserver. Parents may include clusters,folders, and datacenters.
Type StringThe type of object of the server or one of itsparents.
Example: Get hierarchy for all servers in vCenter
Request HeaderGET https://ucpmanagement.ucp.local/api/servers/hierarchyHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "group-d1","Name": "Datacenters","ParentId": null,“Type”: “Folder”
618 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
},{"Id": "datacenter-68","Name": "UCP_Compute","ParentId": "group-d1",“Type”: “Datacenter”},{"Id": "datacenter-7","Name": "UCP_Management","ParentId": "group-d1",“Type”: “Datacenter”},{"Id": "group-h70","Name": "host","ParentId": "datacenter-68",“Type”: “Folder”},{"Id": "group-h9","Name": "host","ParentId": "datacenter-7",“Type”: “Folder”},{"Id": "domain-s96","Name": "esx08.ucp.local","ParentId": "group-h70",“Type”: “ComputeResource”},{"Id": "domain-s90","Name": "esx05.ucp.local","ParentId": "group-h70",“Type”: “ComputeResource”},{"Id": "domain-s87","Name": "esx07.ucp.local","ParentId": "group-h70",“Type”: “ComputeResource”},{"Id": "domain-s84","Name": "esx06.ucp.local","ParentId": "group-h70",“Type”: “ComputeResource”},{"Id": "domain-s81","Name": "esx04.ucp.local","ParentId": "group-h70",
Chapter 2: UCP Director resources 619UCP Director API Reference
Server resources
“Type”: “ComputeResource”},{"Id": "domain-c99","Name": "Cluster01","ParentId": "group-h70",“Type”: “HostCluster”},{"Id": "domain-c12","Name": "UCP_Management_Cluster","ParentId": "group-h9",“Type”: “ClusterComputeResource”},{"Id": "host-98","Name": "esx08.ucp.local","ParentId": "domain-s96",“Type”: “HostSystem”},{"Id": "host-92","Name": "esx05.ucp.local","ParentId": "domain-s90",“Type”: “HostSystem”},{"Id": "host-89","Name": "esx07.ucp.local","ParentId": "domain-s87", “Type”: “HostSystem”},{"Id": "host-86","Name": "esx06.ucp.local","ParentId": "domain-s84",“Type”: “HostSystem”},{"Id": "host-83","Name": "esx04.ucp.local","ParentId": "domain-s81",“Type”: “HostSystem”},{"Id": "host-95","Name": "esx03.ucp.local","ParentId": "domain-c99",“Type”: “HostSystem”},{"Id": "host-79","Name": "esx01.ucp.local",
620 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"ParentId": "domain-c99",“Type”: “HostSystem”},{"Id": "host-76","Name": "esx02.ucp.local","ParentId": "domain-c99",“Type”: “HostSystem”},{"Id": "host-30","Name": "10.21.47.137","ParentId": "domain-c12",“Type”: “HostSystem”},{"Id": "host-15","Name": "10.21.47.135","ParentId": "domain-c12",“Type”: “HostSystem”}}
Example: Get hierarchy for all servers in SCVMMRequest HeaderGET https://ucpmanagement.ucp.local/api/servers/hierarchyHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "0e3ba228-a059-46be-aa41-2f5cf0f4b96e","Name": "All Hosts","ParentId": null,"Type": "HostGroup"}]
List server images
This HTTP request uses the GET method on the /api/servers/images URI. Itlists all images in UCP inventory regardless of image type.
Chapter 2: UCP Director resources 621UCP Director API Reference
Server resources
An optional filter can be appended to the URI for requesting images of acertain type. In such case, use the GET method on/api/servers/images?imageType={IMAGETYPE}.
Image types are:
• Windows
• Linux
• Custom (Returns just one internal UCP image used when deployingcustom UCP service templates.)
• ESXiStateless
Only ESXi images reside in the UCP repository. Windows and Linux imagesreside on the WDS server.
In vCenter, the UCP View privilege is required.
Request body
The body for this request must be empty.
Response body
ESXiStateless images have the following properties.
Name Type Notes
(Common properties) See Common properties
Description String
The image description. Usually derivedfrom the image and contains a statementfrom VMware about the image. If UCP hadcloned this image, it might contain a valuesupplied by the user.
ImageType StringImage type. Always “ESXiStateless” forESXi images.
Name String Name of the image.
AcceptanceLevel String
VMware’s certification level. Values:
• VMwareCertified: VIBs created andtested by VMware. VMware Certified VIBsundergo thorough testing by VMware.
622 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Name Type Notes
• VMwareAccepted: VIBs created by aVMware partners that are approved byVMware. VMware relies on partners toperform the testing, but VMware verifiesthe results.
• PartnerSupported: VIBs created andtested by a trusted VMware partner. Thepartner performs all testing. VMware doesnot verify the results.
• CommunitySupported: VIBs created byindividuals or partners outside of theVMware partner program. These VIBs donot undergo any VMware or trustedpartner testing and are not supported byVMware or its partners.
AssociatedServerTypeArray ofStrings
Model of server with default AutoDeployrule for deploying this image. The Defaultimage always has this value filled out. Butit is null for other ESXi images.
AssociatedServerTypes StringIf UCP hasmore than one server typeassociated with this ESXi image, they willbe listed here.
AssociatedServerCount Int32Number of servers that will apply thisimage after a reboot. This property will bedeprecated in future versions of UCP.
CreatedDate DateTime Date and time that the image was created.
InUse Boolean
States whether this image is used. If anAutoDeploy rule exists for this ESXi image,its value for InUse is “true”. This makesthe image “active.” Active images cannotbe modified or deleted.
IsUcpImage Boolean
Whether UCP has created this image. Usedfor differentiating between ESXi imagesfoundwithin UCP repository versus thosefrom remote locations. Only when thevalue is “true” for IsUcpImage can UCPedit, remove, or apply the image, or use itwith a service template.
Packages Colllection Collection of all packages in the image.
Description String Description of the package.
Chapter 2: UCP Director resources 623UCP Director API Reference
Server resources
Name Type Notes
Id StringSpecifies the ID of the package to beincluded in the image.
Name String Name of the package.
ReleaseDate DateTime Date and time the package was released.
StatelessReady BooleanIndicates if the package is ready for usewith a stateless image.
Summary String Brief summary describing the package.
Vendor String Vendor of the package.
Version String Version of the package.
StatelessReady BooleanIndicates if the image can be used as astateless image.
UpdatedDate DateTime Date and time the image was last updated.
Vendor StringVendor for the image. In the case of UCPESXi images, the vendor is “Hitachi, Ltd”.
Windows images have the following properties.
Name Type Notes
(Common properties) See Common properties
ImageType StringFor Windows images, this is always“Windows”.
WindowsImage Collection Collection of the following properties.
Description String Description of the image.
ImageType StringType of image. Always “Windows” forWindows images.
Name String Name of the image.
Architecture StringComputer architecture of the image,“x64” or “x86”.
BootUnattendFilePathsArray ofStrings
Comma separated list of boot unattendfiles that belongwith this image.
Group StringTheWDS group under which this image iscategorized.
ImageSizeInBytes Int32 Total size of the image file in bytes.
ImageUnattendFilePaths StringComma separated list of the associatedimage unattend files and paths.
Language String Language of the image.
624 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Name Type Notes
Path StringPath where the .wim file (image file) islocated.
Version String Version of the image.
Linux images have the following properties.
Name Type Notes
(Common properties) See Common properties
ImageType String For Linux images, this is always “Linux”.
LinuxImage Collection Collection of the following properties.
Description String Description of the image.
ImageType String Always “Linux” for Linux images.
Name String Name of the image.
Architecture StringComputer architecture of the image,“x64” or “x86”.
Group StringNull for Linux images because WDS doesnot have a category for Linux images.
ImageSizeInBytes Int32 Size of the image file in bytes.
KickstartFilePathsArray ofStrings
Path and name of the kickstart fileassociated with this image.
Language String Language of the image.
Path String Path where this image is located.
Version String Version of Linux.
Example: List all images
Images of all types are returned. For the sake of brevity, this exampledisplays only one image of each type: Windows, Linux, Custom, ESXi.
Request HeaderGET https://ucpmanagement.ucp.local/api/servers/imagesHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Chapter 2: UCP Director resources 625UCP Director API Reference
Server resources
Response Body[{"Id": "5","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.5","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images\/5"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self%7Csubcomponent"}
626 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
],"ImageType": "Linux","LinuxImage": {"Id": "5","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.5","InstanceId": "UCP-123-456-789","Description": "RHEL 6.4","ImageType": "Linux","Name": "RHEL6.4","Architecture": "x64","Group": "","ImageSizeInBytes": 3714472930,"KickstartFilePaths": [
"\\\\10.21.19.247\\REMINST\\Boot\\x64\\Linux\\Images\\RHEL6.4\\KickstartFiles\\RHEL6.4_template.cfg"],"Language": "en-US","Path": "\\Boot\\x64\\Linux\\Images\\RHEL6.4","Version": "6.4"}},{"Id": "6","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.6","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images\/6"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.6&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.6&relation=subcomponent"},{"Rel": "jobs.all",
Chapter 2: UCP Director resources 627UCP Director API Reference
Server resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.6&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.6&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.6&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.6&relation=self%7Csubcomponent"}],"ImageType": "Windows","WindowsImage": {"Id": "6","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.6","InstanceId": "UCP-123-456-789","Description": "Windows Server 2012 SERVERSTANDARD","ImageType": "Windows","Name": "Windows Server 2012 SERVERSTANDARD","Architecture": "x64","BootUnattendFilePaths": [
],"Group": "Windows2012","ImageSizeInBytes": 12013012887,"ImageUnattendFilePaths": [
"\\\\10.21.19.247\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\TemplateWindows2008R2DatacenterImageUnattend.xml",
"\\\\10.21.19.247\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\TemplateWindows2012DatacenterImageUnattend.xml",
"\\\\10.21.19.247\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\TemplateWindows2012DCCoreImageUnattend.xml"],"Language": "en-US","Path": "\\Images\\Windows2012\\Win2012_install-(2).wim","Version": "6.2.9200"
628 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
},
{"Id": "1","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.1","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.1&relation=self%7Csubcomponent"}
Chapter 2: UCP Director resources 629UCP Director API Reference
Server resources
],"EsxiImage": {"Id": "1","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.1","InstanceId": "UCP-123-456-789","Description": "A pre-validated ESXi image for UCP for VMware vSphere","ImageType": "EsxiStateless","Name": "HitachiESXiImage-520HB1","AcceptanceLevel": "PartnerSupported","AssociatedServerType": "Compute Blade 520HB1","AssociatedServerTypes": "Compute Blade 520HB1","AssociatedServersCount": 15,"CreatedDate": "\/Date(1379570820360)\/","InUse": true,"IsUcpImage": true,"Packages": [{"Id": "VMware_bootbank_misc-cnic-register_1.72.1.v50.1i-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_misc-cnic-register_1..72..1..v50..1i-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Broadcom NetXtreme II CNIC Registration Agent","Name": "misc-cnic-register","ReleaseDate": "\/Date(1379570799728)\/","StatelessReady": true,"Summary": "cnic_register: misc driver for VMware ESX","Vendor": "VMware","Version": "1.72.1.v50.1i-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-lpfc820_8.2.3.1-129vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-lpfc820_8..2..3..1-129vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Emulex HBA Driver","Name": "scsi-lpfc820","ReleaseDate": "\/Date(1379570799748)\/","StatelessReady": true,"Summary": "lpfc820: scsi driver for VMware ESX","Vendor": "VMware","Version": "8.2.3.1-129vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_esx-base_5.5.0-0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_esx-base_5..5..0-0..0..1331820",
630 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "VMware ESXi is a thin hypervisor integrated into serverhardware. The compact, hardware embedded architecture of VMware ESXiraises the bar for security and reliability and lays the foundation fora dynamic, automated datacenter.","Name": "esx-base","ReleaseDate": "\/Date(1379570819041)\/","StatelessReady": true,"Summary": "ESXi base system","Vendor": "VMware","Version": "5.5.0-0.0.1331820"},{"Id": "VMware_bootbank_esx-xlibs_5.5.0-0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_esx-xlibs_5..5..0-0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "X.Org base libraries.","Name": "esx-xlibs","ReleaseDate": "\/Date(1379570819095)\/","StatelessReady": true,"Summary": "ESXi X.Org base libraries","Vendor": "VMware","Version": "5.5.0-0.0.1331820"},{"Id": "VMware_bootbank_lsi-msgpt3_00.255.03.03-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_lsi-msgpt3_00..255..03..03-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "LSI Native 12Gbps SAS MPT Driver for vmkernel","Name": "lsi-msgpt3","ReleaseDate": "\/Date(1379570800500)\/","StatelessReady": true,"Summary": "LSI Native 12Gbps SAS MPT Driver","Vendor": "VMware","Version": "00.255.03.03-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_lpfc_10.0.100.1-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_lpfc_10..0..100..1-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Emulex Fibre Channel and FCoE Driver","Name": "lpfc",
Chapter 2: UCP Director resources 631UCP Director API Reference
Server resources
"ReleaseDate": "\/Date(1379570800450)\/","StatelessReady": true,"Summary": "Emulex FC Driver","Vendor": "VMware","Version": "10.0.100.1-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_esx-xserver_5.5.0-0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_esx-xserver_5..5..0-0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "X.Org Xserver and supporting libraries for OpenGLsupport.","Name": "esx-xserver","ReleaseDate": "\/Date(1379570819101)\/","StatelessReady": true,"Summary": "ESXi X.Org Xserver","Vendor": "VMware","Version": "5.5.0-0.0.1331820"},{"Id": "VMware_bootbank_block-cciss_3.6.14-10vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_block-cciss_3..6..14-10vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Driver for HP\/Compaq Smart Array Controllers","Name": "block-cciss","ReleaseDate": "\/Date(1379570800097)\/","StatelessReady": true,"Summary": "cciss: block driver for VMware ESX","Vendor": "VMware","Version": "3.6.14-10vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-fnic_1.5.0.4-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-fnic_1..5..0..4-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Cisco FCOE HBA driver","Name": "scsi-fnic","ReleaseDate": "\/Date(1379570799797)\/","StatelessReady": true,"Summary": "fnic: scsi driver for VMware ESX","Vendor": "VMware","Version": "1.5.0.4-1vmw.550.0.0.1331820"},{
632 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"Id": "VMware_bootbank_sata-ahci_3.0-17vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_sata-ahci_3..0-17vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "AHCI SATA controllers Driver","Name": "sata-ahci","ReleaseDate": "\/Date(1379570799893)\/","StatelessReady": true,"Summary": "ahci: sata driver for VMware ESX","Vendor": "VMware","Version": "3.0-17vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_sata-sata-sil24_1.1-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_sata-sata-sil24_1..1-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Silicon Image 3124\/3132 SATA-2 controllers Driver","Name": "sata-sata-sil24","ReleaseDate": "\/Date(1379570799921)\/","StatelessReady": true,"Summary": "sata_sil24: sata driver for VMware ESX","Vendor": "VMware","Version": "1.1-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_elxnet_10.0.100.0v-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_elxnet_10..0..100..0v-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Native Blade Engine driver for VMware ESX","Name": "elxnet","ReleaseDate": "\/Date(1379570800514)\/","StatelessReady": true,"Summary": "Native Blade Engine driver for VMware ESX","Vendor": "VMware","Version": "10.0.100.0v-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-aacraid_1.1.5.1-9vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-aacraid_1..1..5..1-9vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Adaptec aacraid driver","Name": "scsi-aacraid",
Chapter 2: UCP Director resources 633UCP Director API Reference
Server resources
"ReleaseDate": "\/Date(1379570799952)\/","StatelessReady": true,"Summary": "aacraid: scsi driver for VMware ESX","Vendor": "VMware","Version": "1.1.5.1-9vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ata-pata-cmd64x_0.2.5-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ata-pata-cmd64x_0..2..5-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "CMD64x PATA Driver","Name": "ata-pata-cmd64x","ReleaseDate": "\/Date(1379570799845)\/","StatelessReady": true,"Summary": "pata_cmd64x: ata driver for VMware ESX","Vendor": "VMware","Version": "0.2.5-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-cnic_1.72.52.v55.1-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-cnic_1..72..52..v55..1-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Broadcom NetXtreme II CNIC Ethernet Driver","Name": "net-cnic","ReleaseDate": "\/Date(1379570799670)\/","StatelessReady": true,"Summary": "cnic: net driver for VMware ESX","Vendor": "VMware","Version": "1.72.52.v55.1-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_uhci-usb-uhci_1.0-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_uhci-usb-uhci_1..0-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "USB 1.0 uhci host driver","Name": "uhci-usb-uhci","ReleaseDate": "\/Date(1379570798481)\/","StatelessReady": true,"Summary": "usb-uhci: uhci driver for VMware ESX","Vendor": "VMware","Version": "1.0-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-adp94xx_1.0.8.12-6vmw.550.0.0.1331820",
634 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-adp94xx_1..0..8..12-6vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Adaptec ADP94xx","Name": "scsi-adp94xx","ReleaseDate": "\/Date(1379570800000)\/","StatelessReady": true,"Summary": "adp94xx: scsi driver for VMware ESX","Vendor": "VMware","Version": "1.0.8.12-6vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-be2net_4.6.100.0v-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-be2net_4..6..100..0v-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "OneConnect 10G Network Driver","Name": "net-be2net","ReleaseDate": "\/Date(1379570799718)\/","StatelessReady": true,"Summary": "be2net: net driver for VMware ESX","Vendor": "VMware","Version": "4.6.100.0v-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-megaraid-sas_5.34-9vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-megaraid-sas_5..34-9vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "LSI MegaRAID SAS Driver","Name": "scsi-megaraid-sas","ReleaseDate": "\/Date(1379570799961)\/","StatelessReady": true,"Summary": "megaraid_sas: scsi driver for VMware ESX","Vendor": "VMware","Version": "5.34-9vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-e1000e_1.1.2-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-e1000e_1..1..2-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Intel(R) PRO\/1000 PCI-E Network Driver","Name": "net-e1000e","ReleaseDate": "\/Date(1379570799766)\/",
Chapter 2: UCP Director resources 635UCP Director API Reference
Server resources
"StatelessReady": true,"Summary": "e1000e: net driver for VMware ESX","Vendor": "VMware","Version": "1.1.2-4vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ohci-usb-ohci_1.0-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ohci-usb-ohci_1..0-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "USB 1.0 ohci host driver","Name": "ohci-usb-ohci","ReleaseDate": "\/Date(1379570798471)\/","StatelessReady": true,"Summary": "usb-ohci: ohci driver for VMware ESX","Vendor": "VMware","Version": "1.0-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_lsi-mr3_0.255.03.01-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_lsi-mr3_0..255..03..01-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "LSI Native MegaRAID SAS driver for vmkernel","Name": "lsi-mr3","ReleaseDate": "\/Date(1379570800487)\/","StatelessReady": true,"Summary": "LSI Native MegaRAID SAS","Vendor": "VMware","Version": "0.255.03.01-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-e1000_8.0.3.1-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-e1000_8..0..3..1-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Intel(R) PRO\/1000 Network Driver","Name": "net-e1000","ReleaseDate": "\/Date(1379570799679)\/","StatelessReady": true,"Summary": "e1000: net driver for VMware ESX","Vendor": "VMware","Version": "8.0.3.1-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_esx-tboot_5.5.0-0.0.1331820","ResourceType": "Package",
636 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_esx-tboot_5..5..0-0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Esxi Trusted boot uses Intel TXT to do a \"secure launchof ESXi hypervisor\".","Name": "esx-tboot","ReleaseDate": "\/Date(1379570819051)\/","StatelessReady": true,"Summary": "ESXi Trusted Boot","Vendor": "VMware","Version": "5.5.0-0.0.1331820"},{"Id": "VMware_bootbank_net-bnx2_2.2.3d.v55.2-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-bnx2_2..2..3d..v55..2-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Broadcom NetXtreme II Gigabit Ethernet Driver","Name": "net-bnx2","ReleaseDate": "\/Date(1379570800134)\/","StatelessReady": true,"Summary": "bnx2: net driver for VMware ESX","Vendor": "VMware","Version": "2.2.3d.v55.2-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ata-pata-hpt3x2n_0.3.4-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ata-pata-hpt3x2n_0..3..4-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Highpoint Technology HPT3x2n PATA Driver","Name": "ata-pata-hpt3x2n","ReleaseDate": "\/Date(1379570799854)\/","StatelessReady": true,"Summary": "pata_hpt3x2n: ata driver for VMware ESX","Vendor": "VMware","Version": "0.3.4-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ata-pata-via_0.3.3-2vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ata-pata-via_0..3..3-2vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "VIA SATA Controllers Driver","Name": "ata-pata-via",
Chapter 2: UCP Director resources 637UCP Director API Reference
Server resources
"ReleaseDate": "\/Date(1379570799826)\/","StatelessReady": true,"Summary": "pata_via: ata driver for VMware ESX","Vendor": "VMware","Version": "0.3.3-2vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ima-qla4xxx_2.01.31-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ima-qla4xxx_2..01..31-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "QLogic IMA plugin for 4xxx iSCSI devices.","Name": "ima-qla4xxx","ReleaseDate": "\/Date(1379570800123)\/","StatelessReady": true,"Summary": "qima4xxx: IMA plugin for VMware ESX","Vendor": "VMware","Version": "2.01.31-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ata-pata-amd_0.3.10-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ata-pata-amd_0..3..10-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "AMD\/NVidia PATA Driver","Name": "ata-pata-amd","ReleaseDate": "\/Date(1379570799835)\/","StatelessReady": true,"Summary": "pata_amd: ata driver for VMware ESX","Vendor": "VMware","Version": "0.3.10-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-forcedeth_0.61-2vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-forcedeth_0..61-2vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "nVidia forcedeth driver","Name": "net-forcedeth","ReleaseDate": "\/Date(1379570799698)\/","StatelessReady": true,"Summary": "forcedeth: net driver for VMware ESX","Vendor": "VMware","Version": "0.61-2vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_sata-sata-promise_2.12-3vmw.550.0.0.1331820",
638 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_sata-sata-promise_2..12-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Promise SATA controllers Driver","Name": "sata-sata-promise","ReleaseDate": "\/Date(1379570799902)\/","StatelessReady": true,"Summary": "sata_promise: sata driver for VMware ESX","Vendor": "VMware","Version": "2.12-3vmw.550.0.0.1331820"},{"Id": "Hitachi_bootbank_hfc_1.28.16-30","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.Hitachi_bootbank_hfc_1..28..16-30","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareAccepted","Description": "Hitachi CIM Provider for FC-HBA","Name": "hfc","ReleaseDate": "\/Date(1332248394774)\/","StatelessReady": false,"Summary": "Hitachi FC-HBA 1.28.16-30","Vendor": "Hitachi","Version": "1.28.16-30"},{"Id": "VMware_bootbank_scsi-mptsas_4.23.01.00-9vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-mptsas_4..23..01..00-9vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "LSI Logic Fusion MPT SAS driver","Name": "scsi-mptsas","ReleaseDate": "\/Date(1379570800078)\/","StatelessReady": true,"Summary": "mptsas: scsi driver for VMware ESX","Vendor": "VMware","Version": "4.23.01.00-9vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ipmi-ipmi-devintf_39.1-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ipmi-ipmi-devintf_39..1-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "ipmi driver","Name": "ipmi-ipmi-devintf","ReleaseDate": "\/Date(1379570799631)\/",
Chapter 2: UCP Director resources 639UCP Director API Reference
Server resources
"StatelessReady": true,"Summary": "ipmi_devintf: ipmi driver for VMware ESX","Vendor": "VMware","Version": "39.1-4vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-ips_7.12.05-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-ips_7..12..05-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Adaptec IPS","Name": "scsi-ips","ReleaseDate": "\/Date(1379570800009)\/","StatelessReady": true,"Summary": "ips: scsi driver for VMware ESX","Vendor": "VMware","Version": "7.12.05-4vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_sata-sata-svw_2.3-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_sata-sata-svw_2..3-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "BroadCom\/ServerWorks\/Apple SATA controllers Driver","Name": "sata-sata-svw","ReleaseDate": "\/Date(1379570799930)\/","StatelessReady": true,"Summary": "sata_svw: sata driver for VMware ESX","Vendor": "VMware","Version": "2.3-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-mptspi_4.23.01.00-9vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-mptspi_4..23..01..00-9vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "LSI Logic Fusion MPT SPI driver","Name": "scsi-mptspi","ReleaseDate": "\/Date(1379570799776)\/","StatelessReady": true,"Summary": "mptspi: scsi driver for VMware ESX","Vendor": "VMware","Version": "4.23.01.00-9vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-mpt2sas_14.00.00.00-3vmw.550.0.0.1331820","ResourceType": "Package",
640 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-mpt2sas_14..00..00..00-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "LSI Fusion MPT2 6G SAS driver","Name": "scsi-mpt2sas","ReleaseDate": "\/Date(1379570800059)\/","StatelessReady": true,"Summary": "mpt2sas: scsi driver for VMware ESX","Vendor": "VMware","Version": "14.00.00.00-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-nx-nic_5.0.621-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-nx-nic_5..0..621-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Qlogic 10G Ethernet Driver","Name": "net-nx-nic","ReleaseDate": "\/Date(1379570800088)\/","StatelessReady": true,"Summary": "nx_nic: net driver for VMware ESX","Vendor": "VMware","Version": "5.0.621-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ata-pata-serverworks_0.4.3-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ata-pata-serverworks_0..4..3-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Serverworks PATA Driver","Name": "ata-pata-serverworks","ReleaseDate": "\/Date(1379570799873)\/","StatelessReady": true,"Summary": "pata_serverworks: ata driver for VMware ESX","Vendor": "VMware","Version": "0.4.3-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-aic79xx_3.1-5vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-aic79xx_3..1-5vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "aic79xx driver","Name": "scsi-aic79xx","ReleaseDate": "\/Date(1379570799990)\/","StatelessReady": true,
Chapter 2: UCP Director resources 641UCP Director API Reference
Server resources
"Summary": "aic79xx: scsi driver for VMware ESX","Vendor": "VMware","Version": "3.1-5vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-bnx2i_2.72.11.v55.4-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-bnx2i_2..72..11..v55..4-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Broadcom NetXtreme II iSCSI HBA Driver","Name": "scsi-bnx2i","ReleaseDate": "\/Date(1379570799758)\/","StatelessReady": true,"Summary": "bnx2i: scsi driver for VMware ESX","Vendor": "VMware","Version": "2.72.11.v55.4-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_sata-sata-nv_3.5-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_sata-sata-nv_3..5-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "nVidia SATA controllers Driver","Name": "sata-sata-nv","ReleaseDate": "\/Date(1379570799807)\/","StatelessReady": true,"Summary": "sata_nv: sata driver for VMware ESX","Vendor": "VMware","Version": "3.5-4vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-vmxnet3_1.1.3.0-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-vmxnet3_1..1..3..0-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "VMware vmxnet3","Name": "net-vmxnet3","ReleaseDate": "\/Date(1379570799737)\/","StatelessReady": true,"Summary": "vmxnet3: net driver for VMware ESX","Vendor": "VMware","Version": "1.1.3.0-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_sata-ata-piix_2.12-9vmw.550.0.0.1331820","ResourceType": "Package",
642 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_sata-ata-piix_2..12-9vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Intel PATA\/SATA controllers Driver","Name": "sata-ata-piix","ReleaseDate": "\/Date(1379570800038)\/","StatelessReady": true,"Summary": "ata_piix: sata driver for VMware ESX","Vendor": "VMware","Version": "2.12-9vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-qla4xxx_5.01.03.2-6vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-qla4xxx_5..01..03..2-6vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Qlogic iSCSI HBA Driver","Name": "scsi-qla4xxx","ReleaseDate": "\/Date(1379570800117)\/","StatelessReady": true,"Summary": "qla4xxx: scsi driver for VMware ESX","Vendor": "VMware","Version": "5.01.03.2-6vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-megaraid-mbox_2.20.5.1-6vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-megaraid-mbox_2..20..5..1-6vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "LSI Logic MegaRAID Driver (New Driver)","Name": "scsi-megaraid-mbox","ReleaseDate": "\/Date(1379570799981)\/","StatelessReady": true,"Summary": "megaraid_mbox: scsi driver for VMware ESX","Vendor": "VMware","Version": "2.20.5.1-6vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-qla2xxx_902.k1.1-9vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-qla2xxx_902..k1..1-9vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Qlogic FC HBA Driver","Name": "scsi-qla2xxx",
Chapter 2: UCP Director resources 643UCP Director API Reference
Server resources
"ReleaseDate": "\/Date(1379570800029)\/","StatelessReady": true,"Summary": "qla2xxx: scsi driver for VMware ESX","Vendor": "VMware","Version": "902.k1.1-9vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-mlx4-core_1.9.7.0-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-mlx4-core_1..9..7..0-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Mellanox Technologies ConnectX core driver","Name": "net-mlx4-core","ReleaseDate": "\/Date(1379570799786)\/","StatelessReady": true,"Summary": "mlx4_core: net driver for VMware ESX","Vendor": "VMware","Version": "1.9.7.0-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-mlx4-en_1.9.7.0-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-mlx4-en_1..9..7..0-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Mellanox Technologies ConnectX Ethernet driver","Name": "net-mlx4-en","ReleaseDate": "\/Date(1379570800048)\/","StatelessReady": true,"Summary": "mlx4_en: net driver for VMware ESX","Vendor": "VMware","Version": "1.9.7.0-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_rste_2.0.2.0088-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_rste_2..0..2..0088-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Intel SCU SAS\/SATA for VMware ESX","Name": "rste","ReleaseDate": "\/Date(1379570800437)\/","StatelessReady": true,"Summary": "rste: SCU SAS\/SATA for VMware ESX","Vendor": "VMware","Version": "2.0.2.0088-4vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-igb_2.1.11.1-4vmw.550.0.0.1331820",
644 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-igb_2..1..11..1-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Intel(R) Gigabit Ethernet Network Driver","Name": "net-igb","ReleaseDate": "\/Date(1379570799709)\/","StatelessReady": true,"Summary": "igb: net driver for VMware ESX","Vendor": "VMware","Version": "2.1.11.1-4vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-ixgbe_3.7.13.7.14iov-11vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-ixgbe_3..7..13..7..14iov-11vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Intel(R) 10 Gigabit Ethernet Network Driver","Name": "net-ixgbe","ReleaseDate": "\/Date(1379570800019)\/","StatelessReady": true,"Summary": "ixgbe: net driver for VMware ESX","Vendor": "VMware","Version": "3.7.13.7.14iov-11vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ipmi-ipmi-msghandler_39.1-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ipmi-ipmi-msghandler_39..1-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "ipmi driver","Name": "ipmi-ipmi-msghandler","ReleaseDate": "\/Date(1379570799640)\/","StatelessReady": true,"Summary": "ipmi_msghandler: ipmi driver for VMware ESX","Vendor": "VMware","Version": "39.1-4vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_esx-dvfilter-generic-fastpath_5.5.0-0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_esx-dvfilter-generic-fastpath_5..5..0-0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "This package contains dvfilter-generic-fastpath(TrafficFilter) module.",
Chapter 2: UCP Director resources 645UCP Director API Reference
Server resources
"Name": "esx-dvfilter-generic-fastpath","ReleaseDate": "\/Date(1379570819128)\/","StatelessReady": true,"Summary": "dvfilter-generic-fastpath module","Vendor": "VMware","Version": "5.5.0-0.0.1331820"},{"Id": "VMware_bootbank_net-bnx2x_1.72.56.v55.2-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-bnx2x_1..72..56..v55..2-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Broadcom 10G Network Driver","Name": "net-bnx2x","ReleaseDate": "\/Date(1379570799942)\/","StatelessReady": true,"Summary": "bnx2x: net driver for VMware ESX","Vendor": "VMware","Version": "1.72.56.v55.2-1vmw.550.0.0.1331820"},{"Id": "Hitachi_bootbank_scsi-hfcldd_4.40.16.1172-1OEM.550.0.0.1198611","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.Hitachi_bootbank_scsi-hfcldd_4..40..16..1172-1OEM..550..0..0..1198611","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "HBA Driver","Name": "scsi-hfcldd","ReleaseDate": "\/Date(1373288512949)\/","StatelessReady": true,"Summary": "hfcldd: scsi driver for VMware ESX","Vendor": "Hitachi","Version": "4.40.16.1172-1OEM.550.0.0.1198611"},{"Id": "VMware_bootbank_ata-pata-pdc2027x_1.0-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ata-pata-pdc2027x_1..0-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Promise PATA Driver","Name": "ata-pata-pdc2027x","ReleaseDate": "\/Date(1379570799863)\/","StatelessReady": true,"Summary": "pata_pdc2027x: ata driver for VMware ESX","Vendor": "VMware","Version": "1.0-3vmw.550.0.0.1331820"},{
646 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"Id": "VMware_bootbank_scsi-hpsa_5.5.0-44vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-hpsa_5..5..0-44vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "HP Smart Array SCSI Driver","Name": "scsi-hpsa","ReleaseDate": "\/Date(1379570799660)\/","StatelessReady": true,"Summary": "hpsa: scsi driver for VMware ESX","Vendor": "VMware","Version": "5.5.0-44vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_sata-sata-sil_2.3-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_sata-sata-sil_2..3-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Silicon Image SATA controllers Driver","Name": "sata-sata-sil","ReleaseDate": "\/Date(1379570799912)\/","StatelessReady": true,"Summary": "sata_sil: sata driver for VMware ESX","Vendor": "VMware","Version": "2.3-4vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-bnx2fc_1.72.53.v55.1-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-bnx2fc_1..72..53..v55..1-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Broadcom 10G FCoE Offload Driver","Name": "scsi-bnx2fc","ReleaseDate": "\/Date(1379570800107)\/","StatelessReady": true,"Summary": "bnx2fc: scsi driver for VMware ESX","Vendor": "VMware","Version": "1.72.53.v55.1-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-enic_1.4.2.15a-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-enic_1..4..2..15a-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Cisco VIC Ethernet NIC Driver","Name": "net-enic",
Chapter 2: UCP Director resources 647UCP Director API Reference
Server resources
"ReleaseDate": "\/Date(1379570799689)\/","StatelessReady": true,"Summary": "enic: net driver for VMware ESX","Vendor": "VMware","Version": "1.4.2.15a-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_scsi-megaraid2_2.00.4-9vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_scsi-megaraid2_2..00..4-9vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "LSI Logic MegaRAID Driver","Name": "scsi-megaraid2","ReleaseDate": "\/Date(1379570799972)\/","StatelessReady": true,"Summary": "megaraid2: scsi driver for VMware ESX","Vendor": "VMware","Version": "2.00.4-9vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ata-pata-sil680_0.4.8-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ata-pata-sil680_0..4..8-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "SIL680 IDE\/PATA Controller Driver","Name": "ata-pata-sil680","ReleaseDate": "\/Date(1379570799884)\/","StatelessReady": true,"Summary": "pata_sil680: ata driver for VMware ESX","Vendor": "VMware","Version": "0.4.8-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_misc-drivers_5.5.0-0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_misc-drivers_5..5..0-0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "This package contains miscellaneous drivers thatVMware\u000amaintains internally.\u000a\u000a\u0009vmkplexer-vmkplexer5.5.0-None\u000a\u0009scsi-iscsi_linux_92 1.0.0.2-3vmw.550.0.0.1331820\u000a\u0009shim-libata_9_2_0_0 5.5.0-None\u000a\u0009shim-libata_9_2_1_0 5.5.0-None\u000a\u0009vmklinux-vmklinux_9 5.5.0-None\u000a\u0009shim-vmklinux_9_2_0_0 5.5.0-None\u000a\u0009shim-vmklinux_9_2_1_0 5.5.0-None\u000a\u0009shim-vmklinux_9_2_2_0 5.5.0-None\u000a\u0009shim-libfcoe_9_2_0_0 5.5.0-None\u000a\u0009shim-libfcoe_9_2_1_0 5.5.0-None\u000a\u0009net-libfcoe_
648 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
92 1.0.24.9.3-8vmw.550.0.0.1331820\u000a\u0009usbcore-usb 1.0-3vmw.550.0.0.1331820\u000a\u0009hid-hid 1.0-3vmw.550.0.0.1331820\u000a\u0009usb-storage-usb-storage 1.0-3vmw.550.0.0.1331820\u000a\u0009net-usbnet 1.0-3vmw.550.0.0.1331820\u000a\u0009net-cdc_ether 1.0-3vmw.550.0.0.1331820\u000a\u0009ata-libata_92 3.00.9.2-16vmw.550.0.0.1331820\u000a\u0009shim-libfc_9_2_0_0 5.5.0-None\u000a\u0009shim-libfc_9_2_1_0 5.5.0-None\u000a\u0009net-fcoe1.0.29.9.2-7vmw.550.0.0.1331820\u000a\u0009shim-iscsi_linux_9_2_0_05.5.0-None\u000a\u0009shim-iscsi_linux_9_2_1_0 5.5.0-None\u000a\u0009scsi-libfc_92 1.0.40.9.3-5vmw.550.0.0.1331820\u000a\u0009char-random 1.0-3vmw.550.0.0.1331820\u000a\u0009logical device map for static drivers inthe vmkernel 1.0-1vmw.550.0.0.1331820","Name": "misc-drivers","ReleaseDate": "\/Date(1379570798438)\/","StatelessReady": true,"Summary": "Miscellaneous drivers for ESX","Vendor": "VMware","Version": "5.5.0-0.0.1331820"},{"Id": "VMware_bootbank_ipmi-ipmi-si-drv_39.1-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ipmi-ipmi-si-drv_39..1-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "ipmi driver","Name": "ipmi-ipmi-si-drv","ReleaseDate": "\/Date(1379570799650)\/","StatelessReady": true,"Summary": "ipmi_si_drv: ipmi driver for VMware ESX","Vendor": "VMware","Version": "39.1-4vmw.550.0.0.1331820"},{"Id": "VMware_locker_tools-light_5.5.0-0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_locker_tools-light_5..5..0-0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "This package contains cdrom and floppy images used toinstall the tools inside virtual machines.","Name": "tools-light","ReleaseDate": "\/Date(1379570819065)\/","StatelessReady": true,"Summary": "ESXi tools","Vendor": "VMware","Version": "5.5.0-0.0.1331820"},
Chapter 2: UCP Director resources 649UCP Director API Reference
Server resources
{"Id": "VMware_bootbank_ehci-ehci-hcd_1.0-3vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ehci-ehci-hcd_1..0-3vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "USB 2.0 ehci host driver","Name": "ehci-ehci-hcd","ReleaseDate": "\/Date(1379570798461)\/","StatelessReady": true,"Summary": "ehci-hcd: ehci driver for VMware ESX","Vendor": "VMware","Version": "1.0-3vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_qlnativefc_1.0.12.0-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_qlnativefc_1..0..12..0-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "QLogic Native FC driver for vmkernel","Name": "qlnativefc","ReleaseDate": "\/Date(1379570800475)\/","StatelessReady": true,"Summary": "Qlogic Native FC driver","Vendor": "VMware","Version": "1.0.12.0-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_net-tg3_3.123c.v55.5-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_net-tg3_3..123c..v55..5-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Broadcom NetXtreme I Gigabit Ethernet Driver","Name": "net-tg3","ReleaseDate": "\/Date(1379570800068)\/","StatelessReady": true,"Summary": "tg3: net driver for VMware ESX","Vendor": "VMware","Version": "3.123c.v55.5-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_mtip32xx-native_3.3.4-1vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_mtip32xx-native_3..3..4-1vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "Micron RealSSD PCIe Native Driver",
650 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"Name": "mtip32xx-native","ReleaseDate": "\/Date(1379570800462)\/","StatelessReady": true,"Summary": "P32x\/P42x PCIe SSD","Vendor": "VMware","Version": "3.3.4-1vmw.550.0.0.1331820"},{"Id": "VMware_bootbank_ata-pata-atiixp_0.4.6-4vmw.550.0.0.1331820","ResourceType": "Package","GlobalResourceId": "inst.UCP-123-456-789.pkg.VMware_bootbank_ata-pata-atiixp_0..4..6-4vmw..550..0..0..1331820","InstanceId": "UCP-123-456-789","AcceptanceLevel": "VMwareCertified","Description": "ATI SATA Controllers Driver","Name": "ata-pata-atiixp","ReleaseDate": "\/Date(1379570799817)\/","StatelessReady": true,"Summary": "pata_atiixp: ata driver for VMware ESX","Vendor": "VMware","Version": "0.4.6-4vmw.550.0.0.1331820"}],"StatelessReady": false,"UpdatedDate": "\/Date(1380823250217)\/","Vendor": "Hitachi, Ltd."},"ImageType": "EsxiStateless"},{"Id": "3","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.3","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images\/3"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.3&relation=self"},{"Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 651UCP Director API Reference
Server resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.3&relation=self%7Csubcomponent"},{"CustomImage": {"Id": "3","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.3","InstanceId": "UCP-123-456-789","Description": "Custom Image","ImageType": "Custom","Name": "Custom Image"},"ImageType": "Custom"}}
Example: Get details for image 7
The request below asks for all Linux images. Other values could beESXiSateless, Windows, or Custom.
Request HeaderGET https://ucpmanagement.ucp.local/api/servers/images?imageType=LinuxHTTP/1.1Content-Type: application/json; charset=utf-8
652 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "4","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.4","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images\/4"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.4&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.4&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.4&relation=subcomponent"},
Chapter 2: UCP Director resources 653UCP Director API Reference
Server resources
{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.4&relation=self%7Csubcomponent"}],"ImageType": "Linux","LinuxImage": {"Id": "4","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.4","InstanceId": "UCP-123-456-789","Description": "CentOS 6.4","ImageType": "Linux","Name": "CentOS6.4","Architecture": "x64","Group": "","ImageSizeInBytes": 4351878907,"KickstartFilePaths": [
"\\\\10.21.19.247\\REMINST\\Boot\\x64\\Linux\\Images\\CentOS6.4\\KickstartFiles\\CentOS6.4_template.cfg"],"Language": "en-US","Path": "\\Boot\\x64\\Linux\\Images\\CentOS6.4","Version": "6.4"}},{"Id": "5","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.5","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images\/5"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self"},{"Rel": "jobs.subcomponent",
654 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self%7Csubcomponent"}],"ImageType": "Linux","LinuxImage": {"Id": "5","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.5","InstanceId": "UCP-123-456-789","Description": "RHEL 6.4","ImageType": "Linux","Name": "RHEL6.4","Architecture": "x64","Group": "","ImageSizeInBytes": 3714472930,"KickstartFilePaths": [
"\\\\10.21.19.247\\REMINST\\Boot\\x64\\Linux\\Images\\RHEL6.4\\KickstartFiles\\RHEL6.4_template.cfg"],"Language": "en-US","Path": "\\Boot\\x64\\Linux\\Images\\RHEL6.4","Version": "6.4"}}}
Chapter 2: UCP Director resources 655UCP Director API Reference
Server resources
Get server image by Id
This HTTP request uses the GET method on the /api/servers/images/{IMAGEID} URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
See the ESXiStateless, Windows, or Linux sections under the heading Listserver images.
Example: Get details for image 5
In the example below, the image with Id 5 happens to be a Linux image.
Request HeaderGET https://ucpmanagement.ucp.local/api/servers/images/5HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "5","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.5","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images\/5"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servers\/images"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self"},{
656 Chapter 2: UCP Director resources
UCP Director API Reference
Server resources
"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerImage&targetId=inst.UCP-123-456-789.cmp.1.img.5&relation=self%7Csubcomponent"}],"ImageType": "Linux","LinuxImage": {"Id": "5","ResourceType": "ServerImage","GlobalResourceId": "inst.UCP-123-456-789.cmp.1.img.5","InstanceId": "UCP-123-456-789","Description": "RHEL 6.4","ImageType": "Linux","Name": "RHEL6.4","Architecture": "x64","Group": "","ImageSizeInBytes": 3714472930,"KickstartFilePaths": [
"\\\\10.21.19.247\\REMINST\\Boot\\x64\\Linux\\Images\\RHEL6.4\\KickstartFiles\\RHEL6.4_template.cfg"],"Language": "en-US","Path": "\\Boot\\x64\\Linux\\Images\\RHEL6.4","Version": "6.4"}}
Chapter 2: UCP Director resources 657UCP Director API Reference
Server resources
}
Refresh server inventory
This HTTP request uses the POST method on the /api/servers/refresh URI.UCP will check with HCSM for any changes to the server inventory.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Refresh servers in inventory
Request HeaderPOST https://ucpmanagement.ucp.local/api/servers/refreshHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Refresh server inventory". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Server Identity resourcesServer identity API are listed in the following chart.
Request Method URIvCenterPrivilege
List all identities GET /api/Identities UCP View
Get identity by ID GET /api/identities/{IdentityId} UCP View
List identity types GET /api/identitytypes UCP View
Get filtered list ofidentities by pool type
GET/api/identities?identitytype={IdentityType}
UCP View
658 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
Request Method URIvCenterPrivilege
Get filtered list ofidentities by pool ID
GET/api/identities?identitypoolid={IdentityPoolId}
UCP View
List IP address identitypools
GET /api/identitypools/ipaddress UCP View
Get IP address identitypool by ID
GET/api/identitypools/ipaddress/{Identity Pool Id}
UCP View
Add IP address pool range POST/api/identitypools/ipaddress/{Identity Pool Id}/identitypoolranges
UCPAdministrator
Delete IP address range DELETE
/api/identitypools/ipaddress/{Identity Pool Id}/identitypoolranges/{IdentityPoolRangeId}
UCPAdministrator
List IP address ranges GET/api/identitypools/ipaddress/{Identity Pool Id}/identitypoolranges
UCP View
Get IP address range byID
GET
/api/identitypools/ipaddress/{Identity Pool Id}/identitypoolranges/{IdentityPoolRangeId}
UCP View
List all MAC addressidentity pools
GET /api/identitypools/macaddress UCP View
Get MAC address identitypool by ID
GET/api/identitypools/macaddress/{Identity Pool Id}
UCP View
List MAC address ranges GET/api/identitypools/macaddress/{Identity Pool Id}/identitypoolranges
UCP View
Get MAC address range byID
GET
/api/identitypools/macaddress/{Identity Pool Id}/identitypoolranges/{IdentityPoolRangeId }
UCP View
List WWN identity pools GET /api/identitypools/wwnaddress UCP View
Get WWN identity pool byID
GET/api/identitypools/wwnaddress/{Identity Pool Id}
UCP View
List WWN ranges GET/api/identitypools/wwnaddress/{Identity Pool Id}/identitypoolranges
UCP View
Chapter 2: UCP Director resources 659UCP Director API Reference
Server Identity resources
Request Method URIvCenterPrivilege
Get WWN range by ID GET
/api/identitypools/wwnaddress/{Identity Pool Id}/identitypoolranges/{IdentityPoolRangeId}
UCP View
List UUID identity pools GET /api/identitypools/uuidaddress UCP View
Get UUID identity pool byID
GET/api/identitypools/uuidaddress/{Identity Pool Id}
UCP View
List identities
All identities in use by server profiles are listed by using the GET method onthe api/identities URI.
An identity is an object that contains an address or UUID that are drawnfrom pools and used by server profiles. Each identity is assigned a unique IDnumber. Multiple identities are assigned to a server profile.
This API lists only identities that have been assigned to server profiles. Aserver profile has one IP address and one UUID and two or more MACaddresses, WWPN, and WWNN.
The body of this request must be empty.
The response body lists all identities that have been assigned to serverprofiles. Properties for identities are explained under Get identity by ID.
Example: List all identities
This example lists all identities without the use of a filter.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitiesHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 Ok
660 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
Response BodyFor samples of the identities that would be shown in this response body, seethe section "Get filtered list of reserved identities by pool type" onpage 667.
Get identity by ID
The GET method used on the /api/identities/{IdentityID} URI returns a listof identities in use by server profiles.
The request body of this request must be empty.
The response body contains the details of the requested identity. Allproperties for identities are listed in the following chart.
Name Type Notes
DateAssigned DateTimeDate that the identity (IP or MAC addressor WWNN\PN) was assigned to a serverprofile.
DateCreated DateTimeDate that the identity was drawn from apool.
IdentityPoolRangeId NumberUCP ID of the range the identity wasdrawn from.
IsUserInput BooleanWhen true, the identity wasmanuallytypedwhen the server profile was created.
ServerProfileId StringIf the identity is assigned to a serverprofile, the value for this property will bethe ID of the server profile.
Type StringIdentity type. (See the section Listidentity types.)
Value StringThe actual value of the identity. This willbe the actual IP address, MAC address,WWNN or WWPN or UUID.
Example: Get Identity
Request HeaderGET https://ucpmanagement.ucp.local/api/identities/12HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Chapter 2: UCP Director resources 661UCP Director API Reference
Server Identity resources
Response HeaderStatus: 200 OK
Response Body{"Id": "12","ResourceType": "Identity","GlobalResourceId": "inst.UCP-12333.id.12","InstanceId": "UCP-12333","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.pode.local\/api\/identities\/12"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.pode.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self%7Csubcomponent"
662 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
}],"DateAssigned": "6\/3\/2014 5:38:30 PM +00:00","DateCreated": "6\/3\/2014 5:38:30 PM +00:00","IdentityPoolRangeId": 3,"IsUserInput": false,"ServerProfileId": "2","Type": "IpAddress","Value": "10.21.67.31"}
Get identity by ID
The GET method used on the /api/identities/{IdentityID} URI returns a listof identities in use by server profiles.
The request body of this request must be empty.
The response body contains the details of the requested identity. Allproperties for identities are listed in the following chart.
Name Type Notes
DateAssigned StringDate that the identity (IP or MAC addressor WWNN\PN) was assigned to a serverprofile.
DateCreated DateTimeDate that the identity was drawn from apool.
IdentityId DateTime UCP ID number for the identity.
IdentityPoolRangeId NumberUCP ID of the range the identity wasdrawn from.
ServerProfileId StringIf the identity is assigned to a serverprofile, the value for this property will bethe ID of the server profile.
Type StringIdentity type. (See the section Listidentity types.)
Value StringThe actual value of the identity. This willbe the actual IP address, MAC address,WWNN or WWPN or UUID.
Example: Get Identity by ID
In this example identity 12 is requested. The type is IpAddress.
Request HeaderGET https://ucpmanagement.ucp.local/api/identities/12
Chapter 2: UCP Director resources 663UCP Director API Reference
Server Identity resources
HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "12","ResourceType": "Identity","GlobalResourceId": "inst.UCP-12333.id.12","InstanceId": "UCP-12333","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.pode.local\/api\/identities\/12"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.pode.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self"},{"Rel": "events.subcomponent",
664 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self%7Csubcomponent"}],"DateAssigned": "6\/3\/2014 5:38:30 PM +00:00","DateCreated": "6\/3\/2014 5:38:30 PM +00:00","IdentityId": "12","IdentityPoolRangeId": 3,"ServerProfileId": "2","Type": "IpAddress","Value": "10.21.67.31"}
List identity types
This API returns a list of all valid Identity Types by using a GET method on/api/IdentityTypes.
The body of this request must be empty.
A list of all valid identity types is returned with the following properties.
Name Type Notes
IdentityTypesArray ofStrings
List of string values for identity types.
Example: List identity types
This example returns the list of values for identity types.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitytypesHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Chapter 2: UCP Director resources 665UCP Director API Reference
Server Identity resources
Response Body{"Id": "1","ResourceType": "IdentityType","GlobalResourceId": "inst.UCP-12345.identitytype","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identitytypes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IdentityType&targetId=inst.UCP-12345.identitytype&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IdentityType&targetId=inst.UCP-12345.identitytype&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IdentityType&targetId=inst.UCP-12345.identitytype&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IdentityType&targetId=inst.UCP-12345.identitytype&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IdentityType&targetId=inst.UCP-12345.identitytype&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IdentityType&targetId=inst.UCP-12345.identitytype&relation=self%7Csubcomponent"}],"IdentityTypes": ["IpAddress","MacAddress","Uuid",
666 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"WwnAddress"]}
Get filtered list of reserved identities by pool type
This filtered request uses the GET method on the/api/identities?identitytype={IDENTITYTYPE} URI where the{IDENTITYtYPE} is the type of identity pool.
For a list of identity types use GET api/identitytypes.
The request body of this request must be empty.
The response body contains lists of all identities reserved by server profileswithin the specified pool type.
The properties for identities are explained in section List identities.
Example: List all reserved IP Addresses
This API returns all IP addresses currently reserved by server profiles. Forthe sake of brevity, just one identity is listed below.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/identities?identitytype=IPAddressHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "12","ResourceType": "Identity","GlobalResourceId": "inst.UCP-12333.id.12","InstanceId": "UCP-12333","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.pode.local\/api\/identities\/12"},{
Chapter 2: UCP Director resources 667UCP Director API Reference
Server Identity resources
"Rel": "collection","Href": "https:\/\/ucpmanagement.pode.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=Identity&targetId=inst.UCP-12333.id.12&relation=self%7Csubcomponent"}],"DateAssigned": "6\/3\/2014 5:38:30 PM +00:00","DateCreated": "6\/3\/2014 5:38:30 PM +00:00","IdentityId": "12","IdentityPoolRangeId": 3,"IsUserInput": false,"ServerProfileId": "2","Type": "IpAddress","Value": "10.21.67.31"},
668 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
Example: List all reserved MAC Addresses
This API returns all MAC addresses currently reserved by server profiles. Forthe sake of brevity, just one identity is listed below.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/identities?identitytype=MacAddressHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "2","ResourceType": "Identity","GlobalResourceId": "inst.UCP-12345.id.2","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identities\/2"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.2&relation=self%7Csubcomponent"
Chapter 2: UCP Director resources 669UCP Director API Reference
Server Identity resources
},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.2&relation=self%7Csubcomponent"}],"DateAssigned": "6\/2\/2014 6:44:20 PM +00:00","DateCreated": "6\/2\/2014 6:44:20 PM +00:00","IdentityId": "2","IdentityPoolRangeId": 1,"IsUserInput": false"ServerProfileId": "1","Type": "MacAddress","Value": "D0:5F:CE:01:00:00"},
Example: List all reserved WWN identities
This API returns all WWN identities currently reserved by server profiles.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/identities?identitytype=wwnaddressHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "5","ResourceType": "Identity",
670 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"GlobalResourceId": "inst.UCP-12345.id.5","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identities\/5"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.5&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.5&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.5&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.5&relation=self%7Csubcomponent"}],"DateAssigned": "6\/2\/2014 6:44:20 PM +00:00","DateCreated": "6\/2\/2014 6:44:20 PM +00:00","IdentityId": "5","IdentityPoolRangeId": 2,
Chapter 2: UCP Director resources 671UCP Director API Reference
Server Identity resources
"IsUserInput": false"ServerProfileId": "1","Type": "WwnAddress","Value": "24:00:D0:5F:CE:01:00:00"},
Example: List all UUID identities
This API returns all UUID identities currently generated for server profiles.
Request HeaderGET https://ucpmanagement.ucp.local/api/identities?identitytype=UUIDHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "1","ResourceType": "Identity","GlobalResourceId": "inst.UCP-12345.id.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identities\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.1&relation=subcomponent"},{"Rel": "jobs.all",
672 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12345.id.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=Identity&targetId=inst.UCP-12345.id.1&relation=self%7Csubcomponent"}],"DateAssigned": "6\/2\/2014 6:44:20 PM +00:00","DateCreated": "6\/2\/2014 6:44:20 PM +00:00","IdentityId": "1","IdentityPoolRangeId": 0,"IsUserInput": false"ServerProfileId": "1","Type": "Uuid","Value": "441BA4EB-A168-4081-9CA4-6DD433838865"},
Get filtered list of reserved identities by pool ID
This filtered request uses the GET method on the/api/identities?identitypoolid={IDENTITYPOOLID} URI where the{IDENTITYPOOLID} is the ID of the pool.
In the following examples, filters are used in the URI to get only thereserved identities per a specified identity pool.
The request body of this request must be empty.
The response body contains lists of all identities reserved by server profileswithin the specified pool. Properties for identities are explained under Listidentities.
Chapter 2: UCP Director resources 673UCP Director API Reference
Server Identity resources
Example: Get all reserved identities from specified IP Address Pool
Just one identity is listed below, but a real response will include many moreidentities.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitiesHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "4","ResourceType": "Identity","GlobalResourceId": "inst.UCP-12346.id.4","InstanceId": "UCP-12346","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.podj.local\/api\/identities\/4"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.podj.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.4&relation=self%7Csubcomponent"},
674 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
{"Rel": "events.self","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.4&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.4&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.4&relation=self%7Csubcomponent"}],"DateAssigned": "6\/3\/2014 8:00:29 PM +00:00","DateCreated": "6\/3\/2014 8:00:29 PM +00:00","IdentityId": "4","IdentityPoolRangeId": 3,"IsUserInput": false"ServerProfileId": "1","Type": "IpAddress","Value": "10.21.98.11"},…
Example: Get all reserved identities from specified MAC Address Pool
This example gets all reserved identities from the MAC address pool. Thetype MacAddress is case sensitive. Only the first MAC ID is listed below.Real queries will return more.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/identities?identitypoolid=2&identitytype=MacAddressHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[
Chapter 2: UCP Director resources 675UCP Director API Reference
Server Identity resources
{"Id": "2","ResourceType": "Identity","GlobalResourceId": "inst.UCP-12346.id.2","InstanceId": "UCP-12346","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.podj.local\/api\/identities\/2"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.podj.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.2&relation=self%7Csubcomponent"}],"DateAssigned": "6\/3\/2014 8:00:29 PM +00:00",
676 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"DateCreated": "6\/3\/2014 8:00:29 PM +00:00","IdentityId": "2","IdentityPoolRangeId": 1,"IsUserInput": false"ServerProfileId": "1","Type": "MacAddress","Value": "D0:5F:CE:01:00:00"},…
Example: Get all reserved identities from specified WWN Address Pool
This lists all WWPN and WWNN numbers that have been reserved by serverprofiles. The type value of WnnAddress is case sentitive. This exampleshows only a single ID, but many more will normally be listed.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/identities?identitypoolid=4&identitytype=WwnAddressHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "5","ResourceType": "Identity","GlobalResourceId": "inst.UCP-12346.id.5","InstanceId": "UCP-12346","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.podj.local\/api\/identities\/5"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.podj.local\/api\/identities"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.5&relation=self"},{
Chapter 2: UCP Director resources 677UCP Director API Reference
Server Identity resources
"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.5&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.podj.local\/api\/jobs?targetType=Identity&targetId=inst.UCP-12346.id.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.5&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.podj.local\/api\/events?targetType=Identity&targetId=inst.UCP-12346.id.5&relation=self%7Csubcomponent"}],"DateAssigned": "6\/3\/2014 8:00:29 PM +00:00","DateCreated": "6\/3\/2014 8:00:29 PM +00:00","IdentityId": "5","IdentityPoolRangeId": 2,"IsUserInput": false"ServerProfileId": "1","Type": "WwnAddress","Value": "24:00:D0:5F:CE:01:00:00"},…
Example: Get all reserved identities from specified UUID Pool
UUIDs are not held within pools, rather, they are generated when a serverprofile is created. Therefore, no results would be returned by a GET requestfiltered for Uuid pool ID. Instead, use the UUID type as the filter. SeeExample: List all UUID identities.
678 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
List IP address identity pools
This API returns a list of all IP Address Pools by using a GET method on/api/identitypools/ipaddress
The body of this request must be empty.
A list of IP address pools is returned.
Example: List all IP address identity pools
This example lists all IP address identity pools. This version includes justone pool.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitypools/ipaddressHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "1","ResourceType": "IpAddressIdentityPool","GlobalResourceId": "inst.UCP-12345.ippool.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/ipaddress\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/ipaddress"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=self"},
Chapter 2: UCP Director resources 679UCP Director API Reference
Server Identity resources
{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=self%7Csubcomponent"}],"IdentityPoolId": 1,"Name": "IpAddresses","Type": "IpAddress","Ranges": ["3"]}]
Get IP address identity pool by ID
This API returns a specified IP address pool by using a GET method on/api/identitypools/ipaddress/{Identity Pool Id}.
The body of this request must be empty.
The specified IP address pool is returned with the following properties.
680 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
Name Type Notes
Name String Name of the IP address pool.
Type String Type of ID pool.
RangesArray ofStrings
Array of string values for IP address rangesin the pool.
Example: Get IP address pool by ID
This example returns the IP address pool with ID 1.
Request Headerhttps://ucpmanagement.ucp.local/api/identitypools/ipaddress/1HTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "1","ResourceType": "IpAddressIdentityPool","GlobalResourceId": "inst.UCP-12345.ippool.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/ipaddress\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/ipaddress"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=self"},{"Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 681UCP Director API Reference
Server Identity resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPool&targetId=inst.UCP-12345.ippool.1&relation=self%7Csubcomponent"}],"Name": "IpAddresses","Type": "IpAddress","Ranges": ["3"]}
Add IP address pool range
This API adds an IP Address Pool Range to a specified IP address pool byusing the POST method to /api/identitypools/ipaddress/{IdentityPoolId}/identitypoolranges URI.
Note: When entering a value for the DNS Address, use the IP of the AD VM if it isaccessible to the blade servers. If not, use the IP address of the UCPUtility VM.
The request body consists of the following properties:
682 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
Name Type Notes
StartAddress String Starting IP address for the new range.
EndAddress String Ending IP address for the new range.
SubnetMask StringSubnet mask to be applied for the newrange.
DefaultGateway String Default gateway for the new range.
DNSAddress String Domain name server of the new range.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Add IP address range to IP addresspool 1Request HeaderPOSThttps://ucpmanagement.ucp.local/api/identitypools/ipaddress/1/identitypoolrangesHTTP/1.1Content-Type: application/json; charset=utf-8
Request body{"StartAddress":"10.10.6.5","EndAddress":"10.10.6.15","SubnetMask":"255.255.255.0","DefaultGateway":"10.10.6.1","DnsAddress":"10.10.10.1"}
Response HeaderStatus: 202 Accepted
Response BodyThe system executes a job named “Add identity pool range". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
Delete IP address range
This API removes an IP address range from UCP by using the DELETEmethod on /api/identitypools/ipaddress/{IdentityPoolId}/identitypoolranges /{IdentityPoolRangeId}.
The body of this request must be empty.
Chapter 2: UCP Director resources 683UCP Director API Reference
Server Identity resources
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Delete IP address range by IDIn this example, the IP address range with the ID of 14 is deleted.
Request HeaderDELETEhttps://ucpmanagement.ucp.local/api/identitypools/ipaddress/1/identitypoolranges/14HTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 202 Accepted
Response BodyThe system executes a job named “Remove identity pool range from pool".The properties for jobs can be viewed in Common response data under UCPDirector Resources.
List IP address ranges
This API will return all IP address ranges for a specified IP address pool byusing the GET method on /api/identitypools/ipaddress/{IdentityPoolID}/identitypoolranges.
The body of this request must be empty.
All IP ranges in the specified pool are returned. Properties for IP addressranges are detailed in the section Get IP address range by ID.
Example: List allranges in IP address pool 1
Request Headerhttps://ucpmanagement.ucp.local/api/identitypools/ipaddress/1/identitypoolrangesHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
684 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
Response Body[{"Id": "3","ResourceType": "IpAddressIdentityPoolRange","GlobalResourceId": "inst.UCP-12345.ippool.1.range.3","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/ipaddress\/1\/identitypoolranges\/3"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/ipaddress\/1\/identitypoolranges"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=self"},{"Rel": "events.subcomponent",
Chapter 2: UCP Director resources 685UCP Director API Reference
Server Identity resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=self%7Csubcomponent"}],"AllocatedIdentityIds": ["4","12","20","28","36","44"],"Available": 34,"EndAddress": "10.21.20.50","IdentityPoolId": "1","IdentityPoolRangeId": 3,"StartAddress": "10.21.20.11","Total": 40,"DefaultGateway": "10.21.20.1","Dns": "10.21.19.246","SubnetMask": "255.255.255.0"}]
Get IP address range by ID
This API returns an IP Address Pool Range by using the GET method on theapi/identitypools/ipaddress/{identitypoolid}/identitypoolranges/{identitypoolrangeid} URI.
The body of this request must be empty.
The specified IP address range is returned. Properties for IP address rangesare listed in the following chart.
686 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
Name Type Notes
AllocatedIdentityIdsArray ofStrings
Array of string values. These are UCP IDnumbers assigned to each identity.
Available Int32Quantity of available identities in the IPrange.
EndAddress String Ending IP address of the range.
IdentityPoolId StringID of the identity pool that the rangebelongs to.
IdentityPoolRangeId String ID of the IP range.
StartAddress String Starting IP address of the range.
Total Int32Total quantitiy of IP addresses in the IPrange.
DefaultGateway StringIP address of the gateway server for the IPaddress range.
Dns StringIP address of the DNS server for the IPaddress range.
SubnetMask StringSubnet mask used by IP addresses in therange.
Example: Get IP address range 3
Request Headerhttps://ucpmanagement.ucp.local/api/identitypools/ipaddress/1/identitypoolranges/3HTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "3","ResourceType": "IpAddressIdentityPoolRange","GlobalResourceId": "inst.UCP-12345.ippool.1.range.3","InstanceId": "UCP-12345","Links": [{"Rel": "self",
Chapter 2: UCP Director resources 687UCP Director API Reference
Server Identity resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/ipaddress\/1\/identitypoolranges\/3"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/ipaddress\/1\/identitypoolranges"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=IpAddressIdentityPoolRange&targetId=inst.UCP-12345.ippool.1.range.3&relation=self%7Csubcomponent"}],"AllocatedIdentityIds": [
688 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"4","12","20","28","36","44"],"Available": 34,"EndAddress": "10.21.20.50","IdentityPoolId": "1","IdentityPoolRangeId": 3,"StartAddress": "10.21.20.11","Total": 40,"DefaultGateway": "10.21.20.1","Dns": "10.21.19.246","SubnetMask": "255.255.255.0"}]
List all MAC address identity pools
This API returns a list of all MAC address pools by using a GET method on/api/identitypools/macaddress.
The body of this request must be empty.
A list of MAC address pools is returned.
Example: List all MAC address identity pools
This example lists the MAC address identity pools. This version includes justone. Properties for MAC address pools are explained under Get MAC addressidentity pool by ID.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitypools/macaddressHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "2","ResourceType": "MacAddressIdentityPool",
Chapter 2: UCP Director resources 689UCP Director API Reference
Server Identity resources
"GlobalResourceId": "inst.UCP-12345.macpool.2","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/macaddress\/2"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/macaddress"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=self%7Csubcomponent"}],"IdentityPoolId": 2,
690 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"Name": "Default MacAddresses","Type": "MacAddress","Ranges": ["1"]}]
Get MAC address identity pool by ID
This API returns a specified MAC address pool by using a GET method on/api/identitypools/macaddress/{Identity Pool Id}.
The body of this request must be empty.
The specified MAC address pool is returned. Properties for the MAC addresspool are explained in the following table.
Name Type Notes
Name String Name of the MAC address pool.
Type String Type of ID pool.
RangesArray ofStrings
Array of string values for MAC addressranges in the pool.
Example: Get MAC address pool by ID
This example returns the MAC address pool with ID 2.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitypools/macaddress/2HTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "2","ResourceType": "MacAddressIdentityPool","GlobalResourceId": "inst.UCP-12345.macpool.2","InstanceId": "UCP-12345","Links": [{
Chapter 2: UCP Director resources 691UCP Director API Reference
Server Identity resources
"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/macaddress\/2"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/macaddress"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPool&targetId=inst.UCP-12345.macpool.2&relation=self%7Csubcomponent"}],"Name": "Default MacAddresses","Type": "MacAddress","Ranges": ["1"]
692 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
}
List MAC address ranges
This API will return all MAC address ranges for a specified MAC address poolby using the GET method on /api/identitypools/macaddress/{IdentityPoolID}/identitypoolranges.
The body of this request must be empty.
The list of ranges in the specified MAC address identity pool is returned. Atthis time, UCP supports one range and one pool. Properties for MAC addressranges are explained under Get MAC address range by ID.
Example: List MAC address ranges in MAC address pool 2
Request HeaderGEThttps://ucpmanagement.ucp.local/api/identitypools/macaddress/2/identitypoolrangesHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "1","ResourceType": "MacAddressIdentityPoolRange","GlobalResourceId": "inst.UCP-12345.macpool.2.range.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/macaddress\/2\/identitypoolranges\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/macaddress\/2\/identitypoolranges"},
Chapter 2: UCP Director resources 693UCP Director API Reference
Server Identity resources
{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=self%7Csubcomponent"}],"AllocatedIdentityIds": ["2","3","10","11","18","19","26","27","34","35",
694 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"42","43"],"Available": 9204,"EndAddress": "D0:5F:CE:01:23:FF","IdentityPoolId": "2","IdentityPoolRangeId": 1,"StartAddress": "D0:5F:CE:01:00:00","Total": 9216}]
Get MAC address range by ID
This API returns a MAC address range by using the GET method on the/api/identitypools/macaddress/{identitypoolid}/identitypoolranges/{identitypoolrangeid} URI.
The body of this request must be empty.
The specified MAC address range is returned. This version of UCP supportsone MAC address range and pool. Properties of MAC address ranges areexplained in the following table.
Name Type Notes
AllocatedIdentityIdsArray ofStrings
Array of string values. These are UCP IDnumbers assigned to each identity.
Available Int32Quantity of available identities in the MACAddress range.
EndAddress String EndingMAC address of the range.
IdentityPoolId StringID of the identity pool that the rangebelongs to.
StartAddress String Starting MAC address of the range.
Total Int32Total quantitiy of MAC addresses in theMAC range.
Example: Get MAC Address Range 2
Request HeaderGEThttps://ucpmanagement.ucp.local/api/identitypools/macaddress/2/identitypoolranges/1HTTP/1.1Content-Type: application/json; charset=utf-8
Chapter 2: UCP Director resources 695UCP Director API Reference
Server Identity resources
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "1","ResourceType": "MacAddressIdentityPoolRange","GlobalResourceId": "inst.UCP-12345.macpool.2.range.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/macaddress\/2\/identitypoolranges\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/macaddress\/2\/identitypoolranges"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=self"},{
696 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MacAddressIdentityPoolRange&targetId=inst.UCP-12345.macpool.2.range.1&relation=self%7Csubcomponent"}],"AllocatedIdentityIds": ["2","3","10","11","18","19","26","27","34","35","42","43"],"Available": 9204,"EndAddress": "D0:5F:CE:01:23:FF","IdentityPoolId": "2","StartAddress": "D0:5F:CE:01:00:00","Total": 9216}
List WWN identity pools
This API returns a list of all WWN identity pools by using a GET method on/api/identitypools/wwnaddress
The body of this request must be empty.
A list of WWN address pools is returned. Properties for WWN pools aredetailed under Get WWN identity pool by ID.
Example: List all WWN identity pools
The list of WWN address pools is returned. This version includes just one.
Chapter 2: UCP Director resources 697UCP Director API Reference
Server Identity resources
Request HeaderGET https://ucpmanagement.ucp.local/api/Identitypools/wwnaddressHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "4","ResourceType": "WwnAddressIdentityPool","GlobalResourceId": "inst.UCP-12345.wwnpool.4","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress\/4"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self"
698 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self%7Csubcomponent"}],"IdentityPoolId": 4,"Name": "Default WwnAddresses","Type": "WwnAddress","Ranges": ["2"]}]
Get WWN identity pool by ID
This API returns a specified WWN address pool by using the GET method on/api/identitypools/wwnaddress/{Identity Pool Id}.
The body of this request must be empty.
The specified WWN identity pool is returned. This version supports just oneWWN pool. Pool properties are explained in the following chart.
Name Type Notes
Name String Name of the WWN address pool.
Type String Type of ID pool.
RangesArray ofStrings
Array of string values for WWN addressranges in the pool.
Example: Get WWN identity pool
This example gets the WWN address pool with ID 4.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitypools/wwnaddress/4HTTP/1.1
Chapter 2: UCP Director resources 699UCP Director API Reference
Server Identity resources
Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "4","ResourceType": "WwnAddressIdentityPool","GlobalResourceId": "inst.UCP-12345.wwnpool.4","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress\/4"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self"},{"Rel": "events.subcomponent",
700 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self%7Csubcomponent"}],"Name": "Default WwnAddresses","Type": "WwnAddress","Ranges": ["2"]}
Get WWN identity pool by ID
This API returns a specified WWN address pool by using the GET method on/api/identitypools/wwnaddress/{Identity Pool Id}.
The body of this request must be empty.
The specified WWN identity pool is returned. This version supports just oneWWN pool. Pool properties are explained in the following chart.
Name Type Notes
IdentityPoolId Number ID for the WWN pool.
Name String Name of the WWN address pool.
Type String Type of ID pool.
Ranges ArrayArray of string values for WWN addressranges in the pool.
Example: Get WWN identity pool
This example gets the WWN address pool with ID 4.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitypools/wwnaddress/4HTTP/1.1Content-Type: application/json; charset=utf-8
Chapter 2: UCP Director resources 701UCP Director API Reference
Server Identity resources
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "4","ResourceType": "WwnAddressIdentityPool","GlobalResourceId": "inst.UCP-12345.wwnpool.4","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress\/4"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=subcomponent"
702 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPool&targetId=inst.UCP-12345.wwnpool.4&relation=self%7Csubcomponent"}],"IdentityPoolId": 4,"Name": "Default WwnAddresses","Type": "WwnAddress","Ranges": ["2"]}
List WWN ranges
This API returns all WWN ranges in a specified pool by using the GETmethod on the /api/IdentityPools/wwnaddress/{IdentityPoolID}/identitypoolranges URI.
The body of this request must be empty.
The list of ranges in the specified pool is returned. This version of UCPsupports one range and one WWN pool. For properties of WWN ranges, seeGet WWN range by ID.
Example: List WWN ranges in WWN pool 4
This example lists the WWN range in pool ID 4.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/identitypools/wwnaddress/4/identitypoolrangesHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{
Chapter 2: UCP Director resources 703UCP Director API Reference
Server Identity resources
"Id": "2","ResourceType": "WwnAddressIdentityPoolRange","GlobalResourceId": "inst.UCP-12345.wwnpool.4.range.2","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress\/4\/identitypoolranges\/2"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress\/4\/identitypoolranges"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=subcomponent"},{"Rel": "events.all",
704 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=self%7Csubcomponent"}],"AllocatedIdentityIds": ["5","6","7","8","13","14","15","16","21","22","23","24","29","30","31","32","37","38","39","40","45","46","47","48"],"Available": 4584,"EndAddress": "24:00:D0:5F:CE:01:11:FF","IdentityPoolId": "4","IdentityPoolRangeId": 2,"StartAddress": "24:00:D0:5F:CE:01:00:00","Total": 4608}]
Get WWN range by ID
This API returns a WWN address pool range by using the GET method onthe /api/identitypools/wwnaddress/{IdentityPoolID}/identitypoolranges/{identitypoolrangeid} URI.
The body of this request must be empty.
Chapter 2: UCP Director resources 705UCP Director API Reference
Server Identity resources
The WWN range is returned. Properties of WWN ranges are detailed in thefollowing chart.
Name Type Notes
AllocatedIdentityIdsArray ofStrings
Array of string values for all allocatedWWNs in the range.
Available Int32 Quantity of available WWNs in the range.
EndAddress String EndingWWN in the range.
IdentityPoolId StringUCP ID for the WWN pool that the rangebelongs to.
StartAddress String StartingWWN in the range.
Total Int32 Total quantity of WWNs in the range.
Example: Get Wwn Address Range 2
Request HeaderGET https://ucpmanagement.ucp.local/api/IdentityPoolRanges/WwnAddress/2HTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "2","ResourceType": "WwnAddressIdentityPoolRange","GlobalResourceId": "inst.UCP-12345.wwnpool.4.range.2","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress\/4\/identitypoolranges\/2"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/wwnaddress\/4\/identitypoolranges"},{
706 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=WwnAddressIdentityPoolRange&targetId=inst.UCP-12345.wwnpool.4.range.2&relation=self%7Csubcomponent"}],"AllocatedIdentityIds": ["5","6","7","8","13","14","15","16","21","22","23",
Chapter 2: UCP Director resources 707UCP Director API Reference
Server Identity resources
"24","29","30","31","32","37","38","39","40","45","46","47","48"],"Available": 4584,"EndAddress": "24:00:D0:5F:CE:01:11:FF","IdentityPoolId": "4","StartAddress": "24:00:D0:5F:CE:01:00:00","Total": 4608}]
List UUID identity pools
This API returns a list of UUID pools by using the GET method on/api/identitypools/uuid.
The pool will not contain any numbers until server profiles are created. Thisis the only identity type that is generated at the time of server profilecreation. All other types are held in pools and ranges.
The body of this request must be empty.
Alist of UUID pools is returned. UCP supports just one UUID pool at thistime. Properties for UUID pools are explained under Get UUID identity poolby ID.
Example: List UUID identity pools
In this example, a list of UUID identity pools is returned.
Request HeaderGET https://ucpmanagement.ucp.local/api/identitypools/uuidHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
708 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
Response HeaderStatus: 200 OK
Response Body[{"Id": "3","ResourceType": "UuidIdentityPool","GlobalResourceId": "inst.UCP-12345.uuidpool.3","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/uuid\/3"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/uuid"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=subcomponent"},{"Rel": "events.all",
Chapter 2: UCP Director resources 709UCP Director API Reference
Server Identity resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=self%7Csubcomponent"}],"IdentityPoolId": 3,"Name": "Default Uuids","Type": "Uuid"}]
Get UUID identity pool by ID
This API returns a specified UUID Pool by using the GET method on/api/identitypools/UUID/{Identity Pool Id}
The body of this request must be empty.
The specified UUID pool is returned. This version of UCP supports just onepool of each type.
Name Type Notes
Name String Name for the UUID pool.
Type String Type of pool.
Example: Get UUID identity pool by ID
This example gets the UUID identity pool with ID 3.
Request HeaderGET https://ucpmanagement.ucp.local/api/IdentityPools/UUID/3HTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "3","ResourceType": "UuidIdentityPool","GlobalResourceId": "inst.UCP-12345.uuidpool.3","InstanceId": "UCP-12345","Links": [
710 Chapter 2: UCP Director resources
UCP Director API Reference
Server Identity resources
{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/uuid\/3"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/identitypools\/uuid"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=UuidIdentityPool&targetId=inst.UCP-12345.uuidpool.3&relation=self%7Csubcomponent"}],"Name": "Default Uuids","Type": "Uuid"}
Chapter 2: UCP Director resources 711UCP Director API Reference
Server Identity resources
Server profile resourcesA server profile is an abstraction of a server’s identity. It contains EFIsettings and a set of unique identifying numbers that include IP address,MAC addresses, WWPN\WWNN, and UUID. There is a one-to-onerelationship between servers and server profiles.
A profile can only be applied to a blade when its EFI settings are supportedby that blade model. As of UCP 4.0, server profiles do not have a singlecharacteristic that identifies it as belonging to one blade model or another.Therefore, when making server profiles, it is best to put the intended blademodel in the name.
Server profile API are listed in the following chart.
RequestMethod
URIvCenterPrivilege
"List allserverprofiles" onpage 715
GET /api/serverprofiles UCP View
"Get serverprofile" onpage 716
GET /api/serverprofiles UCP View
"Create aserverprofile" onpage 722
POST /api/serverprofilesUCPAdministrator
"Edit aserverprofile" onpage 733
PUT /api/serverprofiles/{ServerProfileID}UCPAdministrator
"Delete aserverprofile" onpage 734
DELETE
/api/serverprofiles/{ServerProfileId}UCPAdministrator
"Apply aserverprofile" onpage 735
POST /api/serverprofiles/{ServerProfileId}/server/{ServerId}UCPAdministrator
712 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
RequestMethod
URIvCenterPrivilege
"List DDRvoltageleveloptions forEFIsettings"onpage 736
GET /api/serverprofiles/efisettings/ddrvoltagelevels UCP View
"Get DDRvoltagelevel optionby ID" onpage 736
GET/api/serverprofiles/efisettings/ddrvoltagelevels/{ddrvoltagelevelid}
UCP View
"Listmemorymodeoptions forEFIsettings"onpage 744
GET /api/serverprofiles/efisettings/memorymodes UCP View
"Getmemorymodeoption byID" onpage 743
GET/api/serverprofiles/efisettings/memorymodes/{memorymodeid}
UCP View
"Listmemorymodeoptions forEFIsettings"onpage 744
GET /api/serverprofiles/efisettings/nodeinterleavemodes UCP View
"Get nodeinterleaveoption byID" onpage 749
GET/api/serverprofiles/efisettings/nodeinterleavemodes/{nodeinterleavemodeid}
UCP View
Chapter 2: UCP Director resources 713UCP Director API Reference
Server profile resources
RequestMethod
URIvCenterPrivilege
"Listmemoryspeedoptions forEFIsettings"onpage 755
GET /api/serverprofiles/efisettings/memoryspeeds UCP View
"Getmemoryspeedoption byID" onpage 754
GET/api/serverprofiles/efisettings/memoryspeeds/{memoryspeedid}
UCP View
"Listprocessorhardwareprefetcheroptions forEFIsettings"onpage 767
GET/api/serverprofiles/efisettings/processorhardwareprefetchermodes
UCP View
"Listprocessorhyper-threadingoptions forEFIsettings"onpage 771
GET/api/serverprofiles/efisettings/processorhyperthreadingmodes
UCP View
"Listprocessorturbomodeoptions forEFIsettings"onpage 776
GET /api/serverprofiles/efisettings/processorturbomodes UCP View
714 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
RequestMethod
URIvCenterPrivilege
"List RASdeconfiguredmodeoptions forEFIsettings"onpage 780
GET /api/serverprofiles/efisettings/rasdeconfiguredmodes UCP View
List all server profiles
This API returns all Server Profiles by using a GET method on the/api/serverprofiles URI.
The body of this request must be empty.
The response body contains an array of properties for each Server Profile inUCP inventory. Properties for server profiles are listed under the headingGet Server Profile.
Example: List all server profiles
In this example, all server profiles are listed.
Request HeaderGET https://ucpmanagement.ucp.local/api/serverprofilesHTTP/1.1Content-Type: application/json; charset=utf-8
Request bodyThe body of this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response BodyAll Server Profiles in UCP inventory are returned.
To see an example of a Server Profile returned in a response body, see thesubheading "Example: Get a server profile" on page 719.
Chapter 2: UCP Director resources 715UCP Director API Reference
Server profile resources
Get server profile
This HTTP request uses the GET method on the /api/serverprofiles/{serverprofileid} URI, where {serverprofileid} specifies the ID of the ServerProfile that is to be returned.
This request requires the UCP View privilege.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
Name Type Notes
CnaSettings Collection Array of CNA settings.
Int32UCP supports only one CNA. This valueshould always be zero.
CollectionArray of controller settings. Eachcontroller has two ports. When it is a four-port CNA, there are two controllers.
Int32The controller number for which thefollowing settings are listed.
CollectionArray of physical port settings, repeatedfor each of the two physical ports on thiscontroller.
BooleanWhether or not virtual ports are enabledon this physical port.
Int32 Port number of the physical CNA port.
BooleanWhether or not PXE is enabled on thephysical port. UCP servers support PXE onthe two ports.
CollectionWhen a physical port is partitioned, therewill be four virtual ports, each with its ownBandwidth, PortNumber, and VlanId.
Int32The percentage of physical portbandwidth ascribed to the virtual CNApartition.
Int32The number of the virtual port - one offour.
716 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
Name Type Notes
Int32Native VLAN ID configured on the virtualchannel. UCP supplies default values forhypervisor server profiles.
VlanId Int32
Native VLAN ID used by the profile.Hypervisor profiles will always use thesame native VLAN ID as is used by theUCPmanagement network.
Specify this only when the profile type isnon-hypervisor. Be sure to input thesame ID once per each ControllerNumber.
Description StringUser-provided description of the serverprofile.
EfiSettings Collection Array of EFI settings
String
Voltage level for DDRmemory.Values:
• Force to 1.50V
• Force to 1.35V
• Auto
• AsIs
String
Memory Mode used for DIMM redundancy.Default is Independent which offers noDIMM redundancy. Values:
• Independent• Mirrorin
g• Sparing• AsIs
String
CPU to Memory Node Interleaving. NUMAis best for hypervisors. Non-Numa isequivalent to UMA. Values:
• NUMA
• NON-NUMA
• AsIs
String
Memory speed. [BS520H A1/B1 model]Values:
• Force DDR3 800
• Force DDR3 1600
Chapter 2: UCP Director resources 717UCP Director API Reference
Server profile resources
Name Type Notes
• Force DDR3 1866
• Auto
• AsIs
[BS520H A2/B2 model] Values:
• Force DDR3 800
• Force DDR3 1066
• Force DDR3 1333
• Force DDR3 1600
• Force DDR3 1866
• Auto
• AsIs
ProcessorHardwarePrefetcher String
Values:
• Enable
• Disable
• AsIs
ProcessorHyperThreading String
Values:
• Enable
• Disable
• AsIs
ProcessorTurboMode String
Values:
• Enable
• Disable
• AsIs
RASDeconfiguredMode String
Values:
• Enable
• Disable
718 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
Name Type Notes
• AsIs
IpAddressSettings Collection Array of IP address settings.
DefaultGateway StringIP address of the default gateway for theserver profile.
StringIP address of the DNS server for theserver profile.
String IP address assigned to the server profile.
StringSubnet mask assigned to the serverprofile.
MacAddressSettings CollectionArray of MAC address settings. Repeatedfor each port used for storage access.
String MAC address used by port.
Int32Specifies which MAC address the abovenumber is enumerated as.
Name String User-provided name of the server profile.
NonHypervisor BooleanIs true when the profile is for non-hypervisor deployments.
ServerUuid String The UUID of the server profile.
WwnAddressSettings Collection
Array of WWN address settings. Thesecollections sequentially represent the listof HBA ports starting with port zero. Thisis true regardless if the server has aseparate Fibre Channel HBA or if thestorage connectivity is supplied by virtualHBA channels on a CNA.
BooleanIf true, this WWN is a WorldWide NodeName. If false, it is a WorldWide PortName.
Int32The HBA or virtual HBA port number thatuses the followingWWN.
StringTheWWN address used by the specifiedport number.
Example: Get a server profile
In this example, a specific server is requested in the URI.
Request HeaderGET https://ucpmanagement.ucp.local/api/serverprofiles/1HTTP/1.1Content-Type: application/json; charset=utf-8
Chapter 2: UCP Director resources 719UCP Director API Reference
Server profile resources
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "1","ResourceType": "ServerProfile","GlobalResourceId": "inst.UCP-12345.srvprofile.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerProfile&targetId=inst.UCP-12345.srvprofile.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerProfile&targetId=inst.UCP-12345.srvprofile.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServerProfile&targetId=inst.UCP-12345.srvprofile.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerProfile&targetId=inst.UCP-12345.srvprofile.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerProfile&targetId=inst.UCP-12345.srvprofile.1&relation=subcomponent"},
720 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServerProfile&targetId=inst.UCP-12345.srvprofile.1&relation=self%7Csubcomponent"}],"CnaSettings": [{"CnaNumber": 0,"ControllerSettings": [{"ControllerNumber": 0,"PhysicalPorts": [{"EnableVirtualPorts": false,"PortNumber": 0,"PxeBootSupport": true,"VirtualPorts": [
],"VlanId": 20},{"EnableVirtualPorts": false,"PortNumber": 1,"PxeBootSupport": true,"VirtualPorts": [
],"VlanId": 20}]}]}],"Description": "Server Profile for Hypervisor server. No EFImanagement.","EfiSettings": {"DDRVoltageLevel": "AsIs","MemoryMode": "AsIs","NodeInterleave": "AsIs","MemorySpeed": "AsIs","ProcessorHardwarePrefetcher": "AsIs","ProcessorHyperThreading": "AsIs","ProcessorTurboMode": "AsIs","RASDeconfiguredMode": "AsIs"},"IpAddressSettings": {"DefaultGateway": "10.21.20.1","DnsAddress": "10.21.19.246","IpAddress": "10.21.20.10",
Chapter 2: UCP Director resources 721UCP Director API Reference
Server profile resources
"SubnetMask": "255.255.255.0"},"NonHypervisor": false,"MacAddressSettings": [{"MacAddress": "D1:5F:CE:01:23:FF","MacNumber": 0},{"MacAddress": "D1:5F:CE:01:23:FE","MacNumber": 1}],"Name": "Blade5","ServerProfileId": 1,"ServerUuid": "41D4E9AA-7738-4FAD-8210-2B7D924436C3","WwnAddressSettings": [{"IsNodeName": true,"PortNumber": 0,"WwnAddress": "25:00:D0:5F:CE:01:11:FF"},{"IsNodeName": true,"PortNumber": 1,"WwnAddress": "25:00:D0:5F:CE:01:11:FE"},{"IsNodeName": false,"PortNumber": 0,"WwnAddress": "25:00:D0:5F:CE:01:11:FD"},{"IsNodeName": false,"PortNumber": 1,"WwnAddress": "25:00:D0:5F:CE:01:11:FC"}]}]
Create a server profile
This HTTP request creates a server profile by using the POST method on the/api/serverprofiles URI.
The setting called “NonHypervisor” should be set to true for non-hypervisorserver profiles, and false for hypervisor server profiles.
722 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
The value of “AsIs” indicates that the EFI setting should not be configured.In such case, configuring this particular EFI setting will be a manual task.
For each EFI setting, the following chart lists the possible values and noteswhich value is configured by default on blades in the factory.
The following table defines the properties and values when creating a serverprofile.
Name Type Notes
CnaControllerSettings Collection
Array of CNA controller settings. The HB1and HB2 blades have one controller withtwo ports. The HB3 blade has twocontrollers with two ports per controller.Repeat this collection once for eachcontroller.
PhysicalPortSettings CollectionArray of physical port settings, repeatedfor each of the two physical ports on theabove specified controller.
EnableVirtualPorts BooleanThe only acceptable value at this time isfalse.
VirtualPortSettings Collection
In the current version of UCP, this itemmust include a blank collection.
When CNA partitioning is supported inthe future, this collection will include thebandwidth assignment and VlanId foreach of the four CNA partitions perphysical port.
VlanID Int32
Applicable only for non-hypervisor serverprofiles. This specifies the native VLAN IDfor the server profile. Send this value oncefor each CNAControllerSettings collection.
Description String Description for the server profile.
EfiSettings CollectionArray of EFI settings. Supply thiscollection only once for the server profile.
DdrVoltageLevel String
Voltage level for DDRmemory. Values:
• Force to 1.50V (default for HB1blades)
• Force to 1.35V
• Auto (default for HB2 and HB3 blades)
Chapter 2: UCP Director resources 723UCP Director API Reference
Server profile resources
Name Type Notes
• AsIs
MemoryMode String
Memory Mode used for DIMM redundancy.Default is Independent which offers noDIMM redundancy. Values:
• Independent (default)
• Mirroring
• Sparing
• AsIs
NodeInterleaveMode String
CPU to Memory Node Interleaving. NUMAis best for hypervisors. Non-Numa isequivalent to UMA. Values:
• NUMA (default)
• NON-NUMA
• AsIs
MemorySpeed String
[520H B1 model] Values:
• Force DDR3 800
• Force DDR3 1600 (default)
• Force DDR3 1866
• Auto
• AsIs
[520H B2 model] Values:
• Force DDR3 800
• Force DDR3 1066
• Force DDR3 1333
• Force DDR3 1600
• Force DDR3 1866
• Auto (default)
• AsIs
724 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
Name Type Notes
[520H B3 model] Values:
• Auto (default)
• Force DDR4 1600
• Force DDR4 1866
• Force DDR4 2133
• AsIs
ProcessorHardwarePrefetcher String
Values:
• Enable (default)
• Disable
• AsIs
ProcessorHyperThreading String
Values:
• Enable (default)
• Disable
• AsIs
ProcessorTurboMode String
Values:
• Enable (default)
• Disable
• AsIs
RASDeconfiguredMode String
Values:
• Enable (default)
• Disable
• AsIs
IpAddressSettings CollectionArray of IP address settings. Supply thiscollection just once for the server profile.
DefaultGateway String
IP address of the default gateway for theserver profile.Both hypervisor and non-hypervisor profiles need to use thegateway that UCP uses.
Chapter 2: UCP Director resources 725UCP Director API Reference
Server profile resources
Name Type Notes
IpAddressSettings String
IP address of the DNS server for theserver profile. Both hypervisor and non-hypervisor profiles need to use the DNSserver that UCP uses.
IdentityPoolId StringID of the IP address identity pool. Supplythis if the profile should take an IP fromthe UCP pool.
IdentityPoolRangeId String
ID of the IP address range within theabove specified pool. Supply this if theprofile should take an IP from the UCPpool
SubnetMask StringSupply a matching subnet mask when anIP is manually given for UserValue.
UsePool BooleanSupply a value of true when IP addressshould be automatically taken from pool.Use false if specifying an IP manually.
UserValue StringSupply a manually entered IP addresswhen the IP is not taken from the UCPpool.
MacAddressSettings Collection
Array of the next four MAC addresssettings.
Repeat this collection:
• 2 times for HB1 and HB2 blades whenthe environment is multi-rack.
• 4 times for HB3 blades in multi-rackenvironments or for HB1 and HB2blades in converged environments.
• 8 times for HB3 blades in convergedenvironments.
IdentityPoolId StringSupply the MAC address pool ID if the MACis to be taken from pool
IdentityPoolRangeId StringSupply the MAC address pool range ID ifthe MAC is to be taken from pool.
UsePool BooleanSpecify true if the MAC address should betaken from pool.
UserValue StringOptionally specifies a manually typedMACaddress rather than drawing the MACfrom pool
726 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
Name Type Notes
Name String User-provided name of the server profile.
NonHypervisor Boolean
Supply a value of true when the profile isfor non-hypervisor deployments. Omitwhen the profile is for hypervisordeployments.
UuidSettings CollectionCollection of the next two UUID settingssupplied once per server profile.
AutoGenerate BooleanSpecify true if UCP should auto-generate aUUID for the server profile.
UserValue StringWhen AutoGenerate is false, supply amanually entered UUID with thisparameter.
WwnAddressSettings Collection
Array of the next four WWN addresssettings. For every WWPN, also supply aWWNN. Every port requires one of each.
In multi-rack environments, all blademodels require:
• 2 WWNN and 2 WWPN
In Converged environments:
• HB1 and HB2 blades need 2 WWNNand 2 WWPN
• HB3 blades need 4 WWNN and 4WWPN
IdentityPoolId StringIf the WWN is to be taken from pool,supply the pool ID with this parameter.
IdentityPoolRangeId StringIf the WWN is to be taken from pool,supply the range ID from the above pool.
UserValue StringWhen WWN are not taken from pool,supply a manually enteredWWN addresswith this parameter.
IsNodeName BooleanIf true, this WWN is a WorldWide NodeName. If false, it is a WorldWide PortName.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Chapter 2: UCP Director resources 727UCP Director API Reference
Server profile resources
Example: Create hypervisor server profile for HB2 blade in multi-rack envir-onmentIn this request body, the value of false for the property “NonHypervisor”dictates that the deployment type will be a hypervisor installation.
Request HeaderPOST https://ucpmanagement.ucp.local/api/serverprofiles
Request Body{"CnaControllerSettings": [{"PhysicalPortSettings": [{"EnableVirtualPorts": false,"VirtualPortSettings": []}]}],"Description": "","EfiSettings": {"DdrVoltageLevel": "Force to 1.50v","MemoryMode": "Independent","NodeInterleave": "NUMA","MemorySpeed": "Force DDR3 1600","ProcessorHardwarePrefetcher": "Enable","ProcessorHyperThreading": "Enable","ProcessorTurboMode": "Enable","RasDeconfiguredMode": "Enable"},"IpAddressSettings": {"IdentityPoolId": "1","IdentityPoolRangeId": "3","UsePool": true},"NonHypervisor": false,"MacAddressSettings": [{"IdentityPoolId": "2","IdentityPoolRangeId": "1","UsePool": true},{"IdentityPoolId": "2","IdentityPoolRangeId": "1","UsePool": true}],"Name": "HB2_DefaultEFI","UuidSettings": {"UsePool": true
728 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
},"WwnAddressSettings": [{"IdentityPoolId": "4","IdentityPoolRangeId": "2","UsePool": true,"IsNodeName": true},{"IdentityPoolId": "4","IdentityPoolRangeId": "2","UsePool": true,"IsNodeName": false},{"IdentityPoolId": "4","IdentityPoolRangeId": "2","UsePool": true,"IsNodeName": true},{"IdentityPoolId": "4","IdentityPoolRangeId": "2","UsePool": true,"IsNodeName": false}]}
Response HeaderStatus: 200 OK
Response BodyThe system executes a job named “Add server profile”. The properties forjobs can be viewed in Common response data under UCP DirectorResources.
Example: Create HB2 hypervisor profile in multi-rack with manually spe-cified IP and MACOne IP address and two MAC addresses are manually specified in thisexample. This is a hypervisor profile. The IP addresses for gateway and DNSmatch those of the IP address range.
Request HeaderPOST https://ucpmanagement.ucp.local/api/serverprofiles
Request Body{"CnaControllerSettings": [{"PhysicalPortSettings": [{"EnableVirtualPorts": false,
Chapter 2: UCP Director resources 729UCP Director API Reference
Server profile resources
"VirtualPortSettings": []}]}],"Description": "HB2 profile - IP and MAC are manually specified","EfiSettings": {"DdrVoltageLevel": "Force to 1.50v","MemoryMode": "Independent","NodeInterleave": "NUMA","MemorySpeed": "Auto","ProcessorHardwarePrefetcher": "Enable","ProcessorHyperThreading": "Enable","ProcessorTurboMode": "Enable","RasDeconfiguredMode": "Enable"},"IpAddressSettings": {"UsePool": false,"UserValue":"10.17.20.25""DnsAddress":"10.17.20.2""DefaultGateway":"10.17.20.1""SubnetMask":"255.255.255.0"
},"NonHypervisor": false,"MacAddressSettings": [{"UsePool":false,"UserValue":"D0:5F:CE:01:23:FF"},{"UsePool":false,"UserValue":"D0:5F:CE:01:23:FE"}],"Name": "Hypervisor Profile","UuidSettings": {"UsePool": true},"WwnAddressSettings": [{"IdentityPoolId": "4","IdentityPoolRangeId": "2","UsePool": true,"IsNodeName": true},{"IdentityPoolId": "4","IdentityPoolRangeId": "2","UsePool": true,"IsNodeName": false},{
730 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"IdentityPoolId": "4","IdentityPoolRangeId": "2","UsePool": true,"IsNodeName": true},{"IdentityPoolId": "4","IdentityPoolRangeId": "2","UsePool": true,"IsNodeName": false}]}
Response HeaderStatus: 200 OK
Response BodyThe system executes a job named “Add server profile”. The properties forjobs can be viewed in Common response data under UCP DirectorResources.
Example: Create a non-hypervisor HB2 profile in converged with WWNNand WWPN manually specifiedRequest HeaderPOST https://ucpmanagement.ucp.local/api/serverprofiles
Request Body{"CnaControllerSettings": [{"PhysicalPortSettings": [{"EnableVirtualPorts": false,"VirtualPortSettings": [],"VlanId":25}]}],"Description": "BareMetal HB2 profile with manually specified WWN","EfiSettings": {"DdrVoltageLevel": "Force to 1.50v","MemoryMode": "Independent","NodeInterleave": "NUMA","MemorySpeed": "Auto","ProcessorHardwarePrefetcher": "Enable","ProcessorHyperThreading": "Enable","ProcessorTurboMode": "Enable","RasDeconfiguredMode": "Enable"},"IpAddressSettings": {"IdentityPoolId": "1","IdentityPoolRangeId": "9",
Chapter 2: UCP Director resources 731UCP Director API Reference
Server profile resources
"UsePool": true},"NonHypervisor": true,"MacAddressSettings": [{"IdentityPoolId": "2","IdentityPoolRangeId": "1","UsePool": true},{"IdentityPoolId": "2","IdentityPoolRangeId": "1","UsePool": true}{"IdentityPoolId": "2","IdentityPoolRangeId": "1","UsePool": true},{"IdentityPoolId": "2","IdentityPoolRangeId": "1","UsePool": true},],"Name": "Non-Hypervisor B2 profile - manual WWNs","UuidSettings": {"UsePool": true},"WwnAddressSettings": [{"UsePool":false,"UserValue":"24:00:D0:5F:CE:01:11:FF","IsNodeName":true},{"UsePool":false,"UserValue":"24:00:D0:5F:CE:01:11:FE","IsNodeName":false},{"UsePool":false,"UserValue":"24:00:D0:5F:CE:01:11:FD","IsNodeName":true},{"UsePool":false,"UserValue":"24:00:D0:5F:CE:01:11:FC","IsNodeName":false}]}
732 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
Response HeaderStatus: 200 OK
Response BodyThe system executes a job named “Add server profile”. The properties forjobs can be viewed in Common response data under UCP DirectorResources.
Edit a server profile
This HTTP request uses the PUT method on the /api/serverprofiles/{serverprofileID} URI, where {serverprofileID} specifies the ID of theserver profile to which the edit should be applied.
In UCP versions 3.5 and 4.0, editing is possible for EFI settings, name,description, and VLAN ID. In newer versions, the CNA settings can also beedited.
The request body contains the same properties as when creating a serverprofile. The provided values will overwrite existing values for the serverprofile. Please see the request body table and the examples under Create aserver profile.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Edit B2 non-hypervisor server profileThis example edits the server profile with ID 3.
Request HeaderPUT https://ucpmanagement.ucp.local/api/serverprofiles/3HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"CnaControllerSettings":[{"PhysicalPortSettings":[{"EnableVirtualPorts":false,"VirtualPortSettings":[]},{"EnableVirtualPorts":false,"VirtualPortSettings":[]}],"VlanId":25}],
Chapter 2: UCP Director resources 733UCP Director API Reference
Server profile resources
"Description":"Changed memory speed to a lower supported speed for B2blades","EfiSettings":{"DdrVoltageLevel":"Force to 1.50V","MemoryMode":"Independent","NodeInterleave":"NUMA","MemorySpeed":"DDR3 1333","ProcessorHardwarePrefetcher":"Enable","ProcessorHyperThreading":"Enable","ProcessorTurboMode":"Enable","RasDeconfiguredMode":"Enable"},"Name":"edited server profile"}
Response HeaderStatus: 200 OK
Response BodyThe system executes a job named “Update server profile”. For common jobproperties, see the Jobs heading under Introducing UCP Director API.
Delete a server profile
This HTTP request uses the DELETE method on the /api/serverprofiles/{serverprofileID} URI, where {serverprofileID} specifies the ID of theserver profile to be deleted. The server profile must first be detached fromits server.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Delete server profileIn this example, the server profile with ID of 5 is deleted.
Request HeaderDELETE https://ucpmanagement.ucp.local/api/serverprofiles/5HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Delete server profile". For common jobproperties, see the Jobs heading under Introducing UCP Director API.
734 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
Apply a server profile
This HTTP request uses the POST method on the /api/serverprofiles/{serverprofileid}/server/{serverid} URI, where {serverprofileid} specifiesthe server profile that should be applied and {serverid} specifies the serverthat it should be applied to.
If the server has been running ESXi, it should either be in maintenancemode or off. It should not be in a cluster and should have no storageattached. If it has been running a non-hypervisor operating system, it mustbe off and have no storage attached.
While applying a server profile alone (outside of the application of a servicetemplate) UCP does not change the boot type. Therefore, non-hypervisorserver profiles can only be applied to blades in Custom boot mode andHypervisor server profiles can only be applied the servers in that mode.
The EFI settings inside the server profile must be applicable to the blademodel that you apply it to.
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Apply server profileIn this example, a server profile is applied to the server specified in the URIby its ID.
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/serverprofiles/5/server/b8aac687-1f1a-4eae-a192-2f49356fc030HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named "Apply server profile". For common jobproperties, see the Jobs heading under Introducing UCP Director API.
Chapter 2: UCP Director resources 735UCP Director API Reference
Server profile resources
Get DDR voltage level option by ID
This API returns the specified option for configuring the DDR voltage levelEFI setting in server profiles by using the GET method onapi/serverprofiles/efisettings/ddrvoltagelevels/{DDRVOLTAGELEVELID}.
The request body of this request must be empty.
The response body contains the name and unique ID for each available DDRVoltage Level option. These values are listed in the table under "Create aserver profile" on page 722.
Example: Get DDR voltage level option by ID
This example returns the specified DDR voltage level option.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/ddrvoltagelevels/2
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response BodyPlease see the example under List DDR voltage level options for EFIsettings.
List DDR voltage level options for EFI settings
This API returns all available options for configuring DDR Voltage Level EFIsettings in a server profile by using the GET method onapi/serverprofiles/efisettings/ddrvoltagelevels.
The request body of this request must be empty.
The response body contains the name and unique ID for each available DDRVoltage Level option.
Example: List DDR voltage level options
This example lists all DDR voltage level options.
736 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/ddrvoltagelevels
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "1","ResourceType": "DdrVoltageLevel","GlobalResourceId": "inst.scProductionA-123-456-789.ddrvoltagelevel.1","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.1&relation=self%7Csubcomponent"},{
Chapter 2: UCP Director resources 737UCP Director API Reference
Server profile resources
"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.1&relation=self%7Csubcomponent"}],"Name": "AsIs"},{"Id": "2","ResourceType": "DdrVoltageLevel","GlobalResourceId": "inst.scProductionA-123-456-789.ddrvoltagelevel.2","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels\/2"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.2&relation=self"},{"Rel": "jobs.subcomponent",
738 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.2&relation=self%7Csubcomponent"}],"Name": "Auto"},{"Id": "5","ResourceType": "DdrVoltageLevel","GlobalResourceId": "inst.scProductionA-123-456-789.ddrvoltagelevel.5","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels\/5"},{"Rel": "collection",
Chapter 2: UCP Director resources 739UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.5&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.5&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.5&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.5&relation=self%7Csubcomponent"}],"Name": "Force to 1.20V"},{"Id": "4","ResourceType": "DdrVoltageLevel",
740 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"GlobalResourceId": "inst.scProductionA-123-456-789.ddrvoltagelevel.4","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels\/4"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.4&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.4&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.4&relation=subcomponent"},{"Rel": "events.all",
Chapter 2: UCP Director resources 741UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.4&relation=self%7Csubcomponent"}],"Name": "Force to 1.35V"},{"Id": "3","ResourceType": "DdrVoltageLevel","GlobalResourceId": "inst.scProductionA-123-456-789.ddrvoltagelevel.3","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels\/3"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/ddrvoltagelevels"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.3&relation=self%7Csubcomponent"},{"Rel": "events.self",
742 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=DdrVoltageLevel&targetId=inst.scProductionA-123-456-789.ddrvoltagelevel.3&relation=self%7Csubcomponent"}],"Name": "Force to 1.50V"}]
Get memory mode option by ID
This API returns the specified memory mode EFI setting by using the GETmethod on api/serverprofiles/efisettings/memorymodes/{MEMORYMODEID}.
Mirroring and sparing are DIMM redundancy technologies. DIMMs must beinstalled in a precise layout before these settings can be used. (Please seethe server hardware documentation). Independent is the default setting. Itoffers the maximum memory amount with no DIMM redundancy.
The request body of this request must be empty.
The response body contains the name and unique ID for each availablememory mode option. The possible values are listed in the table under"Create a server profile" on page 722.
Example: Get memory mode option by ID
This example returns the specified memory mode option.
Chapter 2: UCP Director resources 743UCP Director API Reference
Server profile resources
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/memorymodes/2
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response BodyPlease see the example under List memory mode options for EFI settings.
List memory mode options for EFI settings
This API returns all available options for configuring memory mode EFIsettings in a server profile by using the GET method onapi/serverprofiles/efisettings/memorymodes.
Mirroring and sparing are DIMM redundancy technologies. DIMMs must beinstalled in a precise layout before these settings can be used. (Please seethe server hardware documentation). Independent is the default setting. Itoffers the maximum memory amount with no DIMM redundancy.
The request body of this request must be empty.
The response body contains the name and unique ID for each availablememory mode option.
Example: List memory mode options
This example returns the possible memory mode options that can be usedfor EFI settings in a server profile.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/memorymodes
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "1",
744 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"ResourceType": "MemoryMode","GlobalResourceId": "inst.UCP-12345.memorymode.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/memorymodes\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/memorymodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.1&relation=self%7Csubcomponent"}
Chapter 2: UCP Director resources 745UCP Director API Reference
Server profile resources
],"MemoryModeId": 1,"Name": "AsIs"},{"Id": "2","ResourceType": "MemoryMode","GlobalResourceId": "inst.UCP-12345.memorymode.2","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/memorymodes\/2"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/memorymodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.2&relation=subcomponent"},
746 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.2&relation=self%7Csubcomponent"}],"MemoryModeId": 2,"Name": "Independent"},{"Id": "3","ResourceType": "MemoryMode","GlobalResourceId": "inst.UCP-12345.memorymode.3","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/memorymodes\/3"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/memorymodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.3&relation=self"},
Chapter 2: UCP Director resources 747UCP Director API Reference
Server profile resources
{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.3&relation=self%7Csubcomponent"}],"MemoryModeId": 3,"Name": "Mirroring"},{"Id": "4","ResourceType": "MemoryMode","GlobalResourceId": "inst.UCP-12345.memorymode.4","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/memorymodes\/4"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/memorymodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.4&relation=self%7Csubcomponent"},
748 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.4&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.4&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=MemoryMode&targetId=inst.UCP-12345.memorymode.4&relation=self%7Csubcomponent"}],"MemoryModeId": 4,"Name": "Sparing"}]
Get node interleave option by ID
This API returns the specified node interleave mode by using the GETmethod on api/serverprofiles/efisettings/nodeinterleavemodes{NODEINTERLEAVEMODEID}.
This setting is for the node interleaving technology with values of NUMA ornon-NUMA. A node is defined as a CPU socket with its assigned memorybanks. NUMA mode builds a memory map to instruct the hypervisor oroperating system which memory addresses are local to which CPU. Thisincreases OS performance.
The request body of this request must be empty.
The response body contains the name and unique ID for the available nodeinterleave options. The options are also listed in the table under "Create aserver profile" on page 722.
Example: Get node interleave option by ID
This example returns the specified node interleave option.
Chapter 2: UCP Director resources 749UCP Director API Reference
Server profile resources
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/nodeinterleavemodes/1
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body
See the example under List node interleave options for EFI settings.
List node interleave options for EFI settings
This API returns all available options for configuring node interleave EFIsettings in server profiles by using the GET method onapi/serverprofiles/efisettings/nodeinterleavemodes.
This setting is for the node interleaving technology with values of NUMA ornon-NUMA. A node is defined as a CPU socket with its assigned memorybanks. NUMA mode builds a memory map to instruct the hypervisor oroperating system which memory addresses are local to which CPU. Thisincreases OS performance.
The request body of this request must be empty.
The response body contains the name and unique ID for all available nodeinterleave options.
Example: List node interleave modes
This example lists the node interleave modes.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/nodeinterleavemodes
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{
750 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Id": "1","ResourceType": "NodeInterleaveMode","GlobalResourceId": "inst.UCP-12345.nodeinterleavemode.1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/nodeinterleavemodes\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/nodeinterleavemodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.1&relation=subcomponent"},{"Rel": "events.all",
Chapter 2: UCP Director resources 751UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.1&relation=self%7Csubcomponent"}],"NodeInterleaveModeId": 1,"Name": "AsIs"},{"Id": "3","ResourceType": "NodeInterleaveMode","GlobalResourceId": "inst.UCP-12345.nodeinterleavemode.3","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/nodeinterleavemodes\/3"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/nodeinterleavemodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.3&relation=self"
752 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.3&relation=self%7Csubcomponent"}],"NodeInterleaveModeId": 3,"Name": "Non-NUMA"},{"Id": "2","ResourceType": "NodeInterleaveMode","GlobalResourceId": "inst.UCP-12345.nodeinterleavemode.2","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/nodeinterleavemodes\/2"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/nodeinterleavemodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.2&relation=subcomponent"},{"Rel": "jobs.all",
Chapter 2: UCP Director resources 753UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=NodeInterleaveMode&targetId=inst.UCP-12345.nodeinterleavemode.2&relation=self%7Csubcomponent"}],"NodeInterleaveModeId": 2,"Name": "NUMA"}]
Get memory speed option by ID
This API returns the specified memory speed option for EFI settings in aserver profile by using the GET method onapi/serverprofiles/efisettings/memoryspeeds/{MEMORYSPEEDID} URI.
Before changing this setting, be sure to know the native frequency andcapabilities of the server’s installed memory.
The request body of this request must be empty.
The response body contains the name and unique ID for each availablememory speed option. Possible values are also listed in the table under"Create a server profile" on page 722.
This example returns all memory speed options that can be configured in aserver profile’s EFI settings.
754 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/memoryspeeds/3
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response BodySee the example under List memory speed options for EFI settings.
List memory speed options for EFI settings
This API returns all available options for configuring memory speed EFIsettings in server profiles by using the GET method onapi/serverprofiles/efisettings/memoryspeeds.
Before changing this setting, be sure to know the native frequency andcapabilities of the server’s installed memory.
The request body of this request must be empty.
The response body contains the name and unique ID for each availablememory speed option.
This example returns all memory speed options that can be configured inserver profile EFI settings.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/memoryspeeds
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "1","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.1","InstanceId": "scProductionA-123-456-789","Links": [{
Chapter 2: UCP Director resources 755UCP Director API Reference
Server profile resources
"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.1&relation=self%7Csubcomponent"}],
756 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Name": "AsIs"},{"Id": "2","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.2","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/2"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.2&relation=subcomponent"
Chapter 2: UCP Director resources 757UCP Director API Reference
Server profile resources
},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.2&relation=self%7Csubcomponent"}],"Name": "AUTO"},{"Id": "4","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.4","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/4"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.4&relation=self%7Csubcomponent"},{"Rel": "events.self",
758 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.4&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.4&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.4&relation=self%7Csubcomponent"}],"Name": "Force DDR3 1066"},{"Id": "5","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.5","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/5"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.5&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.5&relation=subcomponent"},
Chapter 2: UCP Director resources 759UCP Director API Reference
Server profile resources
{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.5&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.5&relation=self%7Csubcomponent"}],"Name": "Force DDR3 1333"},{"Id": "6","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.6","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/6"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self",
760 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.6&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.6&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.6&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.6&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.6&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.6&relation=self%7Csubcomponent"}],"Name": "Force DDR3 1600"},{"Id": "7","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.7","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/7"
Chapter 2: UCP Director resources 761UCP Director API Reference
Server profile resources
},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.7&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.7&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.7&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.7&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.7&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.7&relation=self%7Csubcomponent"}],"Name": "Force DDR3 1866"},{"Id": "3",
762 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.3","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/3"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.3&relation=subcomponent"},{"Rel": "events.all",
Chapter 2: UCP Director resources 763UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.3&relation=self%7Csubcomponent"}],"Name": "Force DDR3 800"},{"Id": "8","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.8","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/8"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.8&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.8&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.8&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.8&relation=self"},
764 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.8&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.8&relation=self%7Csubcomponent"}],"Name": "Force DDR4 1600"},{"Id": "9","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.9","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/9"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.9&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.9&relation=subcomponent"},{"Rel": "jobs.all",
Chapter 2: UCP Director resources 765UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.9&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.9&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.9&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.9&relation=self%7Csubcomponent"}],"Name": "Force DDR4 1866"},{"Id": "10","ResourceType": "MemorySpeed","GlobalResourceId": "inst.scProductionA-123-456-789.memoryspeed.10","InstanceId": "scProductionA-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds\/10"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/serverprofiles\/efisettings\/memoryspeeds"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.10&relation=self"},
766 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.10&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.10&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.10&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.10&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=MemorySpeed&targetId=inst.scProductionA-123-456-789.memoryspeed.10&relation=self%7Csubcomponent"}],"Name": "Force DDR4 2133"}]
List processor hardware prefetcher options for EFI settings
This API returns all available options for configuring Processor/HardwarePrefetcher EFI settings in a server profile by using the GET method onapi/serverprofiles/efisettings/processorhardwareprefetchermodes.
The processor hardware prefetcher is a technology that reduces latencyassociated with memory reads. The default value in UCP compute servers isenabled.
Chapter 2: UCP Director resources 767UCP Director API Reference
Server profile resources
The request body of this request must be empty.
The response body contains the name and ID for each available processorhardware prefetcher option.
This example shows both of the processor hardware prefetcher modes.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/processorhardwareprefetchermodes
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "0","ResourceType": "ProcessorHardwarePrefetcherMode","GlobalResourceId": "inst.UCP-12345.processorhardwareprefetchermode.0","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorhardwareprefetchermodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.0&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.0&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.0&relation=self%7Csubcomponent"
768 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.0&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.0&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.0&relation=self%7Csubcomponent"}],"Name": "AsIs"},{"Id": "1","ResourceType": "ProcessorHardwarePrefetcherMode","GlobalResourceId": "inst.UCP-12345.processorhardwareprefetchermode.1","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorhardwareprefetchermodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.1&relation=subcomponent"},{
Chapter 2: UCP Director resources 769UCP Director API Reference
Server profile resources
"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.1&relation=self%7Csubcomponent"}],"Name": "Enable"},{"Id": "2","ResourceType": "ProcessorHardwarePrefetcherMode","GlobalResourceId": "inst.UCP-12345.processorhardwareprefetchermode.2","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorhardwareprefetchermodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.2&relation=self"},{"Rel": "jobs.subcomponent",
770 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHardwarePrefetcherMode&targetId=inst.UCP-12345.processorhardwareprefetchermode.2&relation=self%7Csubcomponent"}],"Name": "Disable"}]
List processor hyper-threading options for EFI settings
This API returns all available options for configuring processor hyper-threading modes in the EFI settings for server profiles by using the GETmethod on api/serverprofiles/efisettings/processorhyperthreadingmodes.
This is an Intel technology that allows CPUs to process more than a singleinstruction at a time. The default value for UCP compute servers is enabled.
The request body of this request must be empty.
Chapter 2: UCP Director resources 771UCP Director API Reference
Server profile resources
The response body contains the name and unique ID for each availableprocessor hyper-threading option in EFI settings for server profiles. Thesesettings are listed and explained in the table under "Create a serverprofile" on page 722.
Example: List processor hyper-threading modes
In this example, the modes for hyper-threading settings are returned.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/processorhyperthreadingmodes
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "0","ResourceType": "ProcessorHyperThreadingMode","GlobalResourceId": "inst.UCP-12345.processorhyperthreadingmode.0","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorhyperthreadingmodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.0&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.0&relation=subcomponent"},{"Rel": "jobs.all",
772 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.0&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.0&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.0&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.0&relation=self%7Csubcomponent"}],"Name": "AsIs"},{"Id": "1","ResourceType": "ProcessorHyperThreadingMode","GlobalResourceId": "inst.UCP-12345.processorhyperthreadingmode.1","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorhyperthreadingmodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.1&relation=self"},{"Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 773UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.1&relation=self%7Csubcomponent"}],"Name": "Enable"},{"Id": "2","ResourceType": "ProcessorHyperThreadingMode","GlobalResourceId": "inst.UCP-12345.processorhyperthreadingmode.2","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorhyperthreadingmodes"},{"Rel": "jobs.self",
774 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorHyperThreadingMode&targetId=inst.UCP-12345.processorhyperthreadingmode.2&relation=self%7Csubcomponent"}],"Name": "Disable"}]
Chapter 2: UCP Director resources 775UCP Director API Reference
Server profile resources
List processor turbo mode options for EFI settings
This API returns all available options for configuring processor turbo modeEFI settings in a server profile by using the GET method onapi/serverprofiles/efisettings/processorturbomodes.
This is a CPU performance improvement technology from Intel. The defaultsetting in UCP compute servers is enabled.
The request body of this request must be empty.
The response body contains the name and unique ID for each availableprocessor turbo mode option.
This example returns the processor turbo mode options for EFI settings inserver profiles.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/processorturbomodes
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "0","ResourceType": "ProcessorTurboMode","GlobalResourceId": "inst.UCP-12345.processorturbomode.0","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorturbomodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.0&relation=self"},{
776 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.0&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.0&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.0&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.0&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.0&relation=self%7Csubcomponent"}],"Name": "AsIs"},{"Id": "1","ResourceType": "ProcessorTurboMode","GlobalResourceId": "inst.UCP-12345.processorturbomode.1","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorturbomodes"},{"Rel": "jobs.self",
Chapter 2: UCP Director resources 777UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.1&relation=self%7Csubcomponent"}],"Name": "Enable"},{"Id": "2","ResourceType": "ProcessorTurboMode","GlobalResourceId": "inst.UCP-12345.processorturbomode.2","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/processorturbomodes"
778 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=ProcessorTurboMode&targetId=inst.UCP-12345.processorturbomode.2&relation=self%7Csubcomponent"}],"Name": "Disable"}]
Chapter 2: UCP Director resources 779UCP Director API Reference
Server profile resources
List RAS deconfigured mode options for EFI settings
This API returns all available options for configuring RAS deconfiguredmode EFI settings in server profiles by using the GET method onapi/serverprofiles/efisettings/rasdeconfiguredmodes.
RAS stands for Reliability, Availability, and Serviceability. This is anindustry standard term that includes memory correction technologies likeEEC, mirroring and sparing. The default mode in UCP compute servers isEnabled. Leaving it enabled allows the server to quarantine a faulty CPU orDIMM and continue running. Disabling this mode ensures that a server willnot boot with any CPU or DIMM quarantined and thus always ensure themaximum amount of resources.
The request body of this request must be empty.
The response body contains the name and unique ID for each available RASdeconfigured mode option.
Example: List RAS deconfigured modes
This example returns the RAS deconfigured mode options for EFI settings inserver profiles.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/serverprofiles/efisettings/rasdeconfiguredmodes
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "0","ResourceType": "RasDeconfiguredMode","GlobalResourceId": "inst.UCP-12345.rasdeconfiguredmode.0","InstanceId": "UCP-12345","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/rasdeconfiguredmodes"
780 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.0&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.0&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.0&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.0&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.0&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.0&relation=self%7Csubcomponent"}],"Name": "AsIs"},{"Id": "1","ResourceType": "RasDeconfiguredMode","GlobalResourceId": "inst.UCP-12345.rasdeconfiguredmode.1","InstanceId": "UCP-12345","Links": [{"Rel": "collection",
Chapter 2: UCP Director resources 781UCP Director API Reference
Server profile resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/rasdeconfiguredmodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.1&relation=self%7Csubcomponent"}],"Name": "Enable"},{"Id": "2","ResourceType": "RasDeconfiguredMode","GlobalResourceId": "inst.UCP-12345.rasdeconfiguredmode.2","InstanceId": "UCP-12345",
782 Chapter 2: UCP Director resources
UCP Director API Reference
Server profile resources
"Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.poda.local\/api\/serverprofiles\/efisettings\/rasdeconfiguredmodes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=RasDeconfiguredMode&targetId=inst.UCP-12345.rasdeconfiguredmode.2&relation=self%7Csubcomponent"}],"Name": "Disable"}]
Chapter 2: UCP Director resources 783UCP Director API Reference
Server profile resources
Server type resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List server types" below GET /api/servertypes UCP View
"Get server type" below GET /api/servertypes/{SERVERTYPEID} UCP View
"Set default image for aserver type" on page 786
PUT/api/servertypes/{SERVERTYPEID}/defaultimage
UCP ServerAdministrator
List server types
This HTTP request uses the GET method on the /api/servertypes URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of an array ofinformation for each server type. Properties for server types are detailedunder the heading "Get server type" below.
Example: List all server types
Please see example under "Get server type" below
Get server type
This HTTP request uses the GET method on the /api/servertypes/{SERVERTYPEID} URI, where {SERVERTYPEID} specifies the name of theserver type that is to be returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of the propertiesdetailed in the following table.
784 Chapter 2: UCP Director resources
UCP Director API Reference
Server type resources
Name Type Notes
DefaultImageId String
Default Image ID for server type. When aserver is in ESXiStateless boot type, this isthe image that will be deployed if noindividual auto deploy rule exists for thisserver.
DefaultImageName String Default Image name for server type
ServerType String Server type name
Example: Get a server type
In this example, the specified server type is returned.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/servertypes/Compute%20Blade%20520HB3HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "Compute Blade 520HB3","ResourceType": "ServerType","GlobalResourceId": "inst.v2ProductionE-123-456-789.cmp.1.st.ComputeBlade 520HB3","InstanceId": "v2ProductionE-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.pode.local\/api\/servertypes\/Compute%20Blade%20520HB3"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.pode.local\/api\/servertypes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=ServerType&targetId=inst.v2ProductionE-123-456-789.cmp.1.st.Compute%20Blade%20520HB3&relation=self"
Chapter 2: UCP Director resources 785UCP Director API Reference
Server type resources
},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=ServerType&targetId=inst.v2ProductionE-123-456-789.cmp.1.st.Compute%20Blade%20520HB3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/jobs?targetType=ServerType&targetId=inst.v2ProductionE-123-456-789.cmp.1.st.Compute%20Blade%20520HB3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=ServerType&targetId=inst.v2ProductionE-123-456-789.cmp.1.st.Compute%20Blade%20520HB3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=ServerType&targetId=inst.v2ProductionE-123-456-789.cmp.1.st.Compute%20Blade%20520HB3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.pode.local\/api\/events?targetType=ServerType&targetId=inst.v2ProductionE-123-456-789.cmp.1.st.Compute%20Blade%20520HB3&relation=self%7Csubcomponent"}],"DefaultImageId": "4","DefaultImageName": "HitachiESXiImage-55U2-20150313-520HB3","ServerType": "Compute Blade 520HB3"}
Set default image for a server type
This HTTP request uses the PUT method on the /api/servertypes/{SERVERTYPEID}/defaultimage URI, where {SERVERTYPEID} specifiesthe name of the server type to be updated.
786 Chapter 2: UCP Director resources
UCP Director API Reference
Server type resources
Applicable only when the virtual platform manager is vCenter. A defaultimage can only be an ESXi image.
In vCenter, the UCP Server Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
ImageId StringSpecifies the default ESXi image ID for theserver type.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Set a default image for a server type
In this example, image with ID 1 is configured as the default ESXi image forthe server type specified in the URI.
Request HeaderPUThttps://ucpmanagement.ucp.local/api/servertypes/Compute%20Blade%20520HB1/defaultimageHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"ImageId": "1"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Set a default image for a server type".For common job properties, see the Jobs heading under Introducing UCPDirector API. The properties for jobs can be viewed in Common responsedata under UCP Director Resources.
Chapter 2: UCP Director resources 787UCP Director API Reference
Server type resources
Service Template ResourcesService template API are listed in the following chart.
Request Method URI Privilege
"List all servicetemplates" onpage 790
GET /api/servicetemplatesUCP Viewprivilege
"Create Linux servicetemplate" onpage 791
POST /api/servicetemplates/linuxUCPAdministrator
"List Linux servicetemplates" onpage 793
GET /api/servicetemplates/linux UCP View
"Get Linux servicetemplate by ID" onpage 793
GET/api/servicetemplate/linux/{SERVICETEMPLATEID}
UCP View
"Edit Linux servicetemplate" onpage 795
PUT/api/servicetemplate/linux/{SERVICETEMPLATEID}
UCPAdministrator
"Apply Linux servicetemplate" onpage 797
POST/api/servicetemplate/linux/{SERVICETEMPLATEID}/servers
UCPAdministrator
"Create Windowsservice template" onpage 799
POST /api/servicetemplates/windowsUCPAdministrator
"List Windows servicetemplates" onpage 801
GET /api/servicetemplates/windows UCP View
"Get Windows servicetemplate" onpage 802
GET/api/servicetemplate/windows/{SERVICETEMPLATEID}
UCP View
"Edit Windows servicetemplate" onpage 804
PUT/api/servicetemplate/windows/{SERVICETEMPLATEID}
UCPAdministrator
"Apply Windowsservice template" onpage 806
POST/api/servicetemplate/windows/{SERVICETEMPLATEID}/servers
UCPAdministrator
"Create ESXi hostservice template" onpage 807
POST /api/servicetemplates/ESXiUCPAdministrator
788 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Request Method URI Privilege
"List ESXi host servicetemplates" onpage 809
GET /api/servicetemplates/ESXi UCP View
"Get ESXi host servicetemplate" onpage 810
GET/api/servicetemplate/ESXi/{SERVICETEMPLATEID}
UCP View
"Edit ESXi host servicetemplate" onpage 812
PUT/api/servicetemplate/ESXi/{SERVICETEMPLATEID}
UCPAdministrator
"Apply ESXi hostservice template" onpage 814
POST/api/servicetemplate/ESXi/{SERVICETEMPLATEID}/servers
UCPAdministrator
"Create ESXi clusterservice template" onpage 816
POST /api/servicetemplates/esxistatelessclusterUCPAdministrator
"List ESXi clusterservice templates" onpage 820
GET /api/servicetemplates/esxistatelesscluster UCP View
"Get ESXi clusterservice template" onpage 820
GET/api/servicetemplate/esxistatelesscluster/{SERVICETEMPLATEID}
UCP View
"Get ESXi clusterservice template" onpage 820
PUT/api/servicetemplate/esxistatelesscluster/{SERVICETEMPLATEID}
UCPAdministrator
"Apply cluster servicetemplate" onpage 826
POST /api/clustersUCPAdministrator
"Create customservice template" onpage 826
POST /api/servicetemplates/customUCPAdministrator
"List custom servicetemplates" onpage 827
GET /api/servicetemplates/custom UCP View
"Get custom servicetemplate" onpage 827
GET/api/servicetemplate/custom/{SERVICETEMPLATEID}
UCP View
"Edit custom servicetemplate" onpage 829
PUT/api/servicetemplate/custom/{SERVICETEMPLATEID}
UCPAdministrator
Chapter 2: UCP Director resources 789UCP Director API Reference
Service Template Resources
Request Method URI Privilege
"Apply custom servicetemplate" onpage 830
POST/api/servicetemplate/custom/{SERVICETEMPLATEID}/servers
UCPAdministrator
"Create WindowsHyper-V servicetemplate" onpage 832
POST /api/servicetemplates/windowshypervUCPAdministrator
"List Windows Hyper-V service templates"on page 834
GET /api/servicetemplates/windowshyperv UCP View
"Get Windows Hyper-V service template" onpage 834
GET/api/servicetemplate/windowshyperv/{SERVICETEMPLATEID}
UCP View
"Edit Windows Hyper-V service template" onpage 836
PUT/api/servicetemplate/windowshyperv/{SERVICETEMPLATEID}
UCPAdministrator
"Apply WindowsHyper-V servicetemplate" onpage 839
POST/api/servicetemplate/windowshyperv/{SERVICETEMPLATEID}/servers
UCPAdministrator
"Delete servicetemplate" onpage 841
DELETE/api/servicetemplates/{SERVICETEMPLATEID}
UCPAdministrator
"Copy servicetemplate " onpage 841
POST/api/servicetemplates/{SERVICETEMPLATEID}/?action=copy
UCPAdministrator
"List volumesassociated with aservice template" onpage 842
GET/api/servicetemplates/{SERVICETEMPLATEID}/servicetemplatevolumes
UCP View
"Get details for avolume associatedwith a servicetemplate" onpage 846
GET
/api/servicetemplates/{SERVICETEMPLATEID}/servicetemplatevolumes/{SERVICETEMPLATEVOLUMEID}
UCP View
List all service templates
This API returns all service templates.
The body for this request must be empty.
790 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
The response body contains lists of all templates. Each template contains Idinformation as well as details specific to the template type. These details areshown below in the sections for making each template type.
Example: List service templates
Seethe examples undereach service template type.
Create Linux service template
This public HTTP request uses the POST method on/api/servicetemplates/linux URI.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the properties in the following chart.
Name Type Notes
BootImageId String ID of boot image to use.
ComputeVlanIds StringTrunk VLAN IDs to be applied to attachedphysical Ethernet switch ports.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Optional array of details per each existingvolume to attach. These volumes will beattached to hosts deployed by thistemplate.
StorageSystemId StringID of the storage system where theexisting volume is to be found.
VolumeId StringID of the existing volume as designatedby UCP. This is different from the LUNnumber.
StorageSystemPortIds StringList of SAN ports to use. If not specified,UCP will determine best ports.
BootVolumePoolId StringThe pool in which to create the bootvolume.
BootVolumeSizeInBytes Float Size of boot volume.
BootVolumeStorageSystemId StringStorage system ID. Obtain with GETmethod on: api/storagesystems.
Chapter 2: UCP Director resources 791UCP Director API Reference
Service Template Resources
Name Type Notes
KickstartFileLocation String
Kickstart file location and name. This canbe obtainedwith the GETmethod on:api/server/images/{IMAGEID} whereimageId is the boot image ID for thistemplate.
VolumesToCreateArray ofCollections
Optional array of volumes to create andattach to hosts deployed by this template.
PoolId StringID of the pool in which to create thevolume.
VolumeSizeInBytes Float Size of volume to create.
StorageSystemId StringStorage system in which to create thevolume.
StorageSystemPortIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will automatically selectports.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Create new Linux service template using specific SAN portsRequest HeaderPOST https://ucpmanagement.ucp.local/api/servicetemplates/linuxHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"BootImageId":"3","ComputeVlanIds":"77","Name":"CentOS6.5","VolumesToAttach":[{"StorageSystemId":"53106","VolumeId":"14849","StorageSystemPortIds":["CL1-C","CL2-C","CL3-C","CL4-C"]},{"StorageSystemId":"53106","VolumeId":"14848","StorageSystemPortIds":["CL1-C","CL2-C","CL3-C","CL4-C"]}],"BootVolumePoolId":"3","BootVolumeSizeInBytes":107374182400,"BootVolumeStorageSystemId":"53106",
792 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"KickstartFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Linux\\Images\\CentOS6.4\\KickstartFiles\\CentOS6.4_template.cfg","VolumesToCreate":[{"PoolId":"3","VolumeSizeInBytes":107374182400,"StorageSystemId":"53106","StorageSystemPortIds":["CL1-C","CL2-C","CL3-C","CL4-C"]}]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Create service template". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
List Linux service templates
This HTTP request uses the GET method on the /api/servicetemplates/linuxURI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
All Linux service templates are returned.
Example: List Linux service templates
This HTTP request uses the GET method on the /api/servicetemplates/linuxURI.
In vCenter, the UCP View privilege is required.
Get Linux service template by ID
This HTTP request uses the GET method on the/api/servicetemplates/linux/{SERVICETEMPLATEID} URI, where{SERVICETEMPLATEID} is the ID of the linux service template to return.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
The specified Linux service template is returned.
Chapter 2: UCP Director resources 793UCP Director API Reference
Service Template Resources
Example: Get Linux service template by ID
View details of a single service template by specifying the type and the ID inthe URI.
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/linux/5
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "5","ResourceType": "ServiceTemplate","GlobalResourceId": "inst.UCP-12346.svctmplt.5","InstanceId": "UCP-12346","Links": [{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.5&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.5&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.5&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.5&relation=self"},{"Rel": "events.subcomponent",
794 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.5&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.5&relation=self%7Csubcomponent"}],"BootImageId": "21","BootImageName": "CentOS6.3","BootImageType": "Linux","ComputeVlanIds": "100","Name": "LinuxTemplate","ServiceTemplateType": "Linux","BootVolumePoolId": "1","BootVolumeSizeInBytes": 85899345920,"BootVolumeStorageSystemId": "93042296","KickstartFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Linux\\Images\\CentOS6.3\\KickstartFiles\\CentOS6.3_template.cfg"}
Edit Linux service template
This HTTP request uses the PUT method on the /api/servicetemplates/linux/{SERVICETEMPLATEID} URI. The template type is specified in the URI.UCP validates the supplied values against the OS type.
Note that the unchanged existing values of the service template must besubmitted again along with any changed values. For example, if thetemplate currently specifies VolumesToAttach, it must be resubmittedwhen editing the template, otherwise, the values are deleted from theservice template.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the following properties.
Name Type Notes
BootImageId String ID of boot image to use.
ComputeVlanIds StringTrunk VLAN IDs to be applied to attachedphysical Ethernet switch ports.
Chapter 2: UCP Director resources 795UCP Director API Reference
Service Template Resources
Name Type Notes
Name String Name of the service template
VolumesToAttachArray ofCollections
Optional array of details per each existingvolume to attach. These volumes will beattached to hosts deployed by thistemplate.
StorageSystemId StringID of the storage system where theexisting volume is to be found.
VolumeId StringID of the existing volume as designatedby UCP. This is different from the LUNnumber.
StorageSystemPortIdsArray ofStrings
Storage system ports to use. If notspecified, UCP selects the best storagesystem ports
BootVolumePoolId StringPool ID in which to create the bootvolume.
BootVolumeSizeInBytes Float Size of the boot volume to create.
BootVolumeStorageSystemId StringStorage system ID in which to create theboot volume.
KickstartFileLocation String
Kickstart file location and name. This canbe obtainedwith the GETmethod on:/api/servers/images/{IMAGEID} whereimageId is the boot image ID for thistemplate.
VolumesToCreateArray ofCollections
Optional array of volumes to create andattach to hosts deployed by this template.
PooId StringID of the pool in which to create thevolume.
VolumeSizeInBytes Float Size of volume to create.
StorageSystemId StringStorage system in which to create thevolume.
StorageSystemPortIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will automatically selectports.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Edit a Linux service templateIn this example, a Linux service template is modified.
796 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Request HeaderPUT https://ucpmanagement.ucp.local/api/servicetemplates/linux/4HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"BootImageId":"3","ComputeVlanIds":"77","Name":"CentOSNew","VolumesToAttach":[{"StorageSystemId":"53106","VolumeId":"14849","StorageSystemPortIds":["CL1-C","CL2-C","CL3-C","CL4-C"]}],"BootVolumePoolId":"3","BootVolumeSizeInBytes":107374182400,"BootVolumeStorageSystemId":"53106",
"KickstartFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Linux\\Images\\CentOS6.4\\KickstartFiles\\CentOS6.4_template.cfg","VolumesToCreate":[{"PoolId":"3","VolumeSizeInBytes":107374182400,"StorageSystemId":"53106",}]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Update service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Apply Linux service template
This HTTP request uses the POST method on thehttps://ucpmanagement.ucp.local/api/servicetemplates/linux/{SERVICETEMPLATEID}/servers API.
Templates may only be applied to servers which are in the appropriatestate. Servers may be:
• Off with no server profile applied and no storage
• Off with a non-hypervisor server profile applied and no storage. Payloadmust reapply same server profile
In vCenter, the UCP System Administrator privilege is required.
Chapter 2: UCP Director resources 797UCP Director API Reference
Service Template Resources
Request body
The items in the following table must be supplied in the request body.
Name Type Notes
TargetServersArray ofCollections
Array of server IDs, each with a serverprofile ID.
ServerId StringID of the server to which the servicetemplate will be applied.
ServerProfileId Int32ID of the server profile that should beapplied (or reapplied) to the above server.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Apply a Linux service template to two serversRequest HeaderPOSThttps://ucpmanagement.ucp.local/api/servicetemplates/linux/11/serversHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"TargetServers":[ {"ServerId":"adaadd1d-8ff3-11e1-a013-b46356a328a0","ServerProfileId":14},{"ServerId":"a87788f9-9093-11e1-b9a0-a0c2aaa89bc5","ServerProfileId":15} ]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Apply Linux service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
798 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Create Windows service template
This public HTTP request uses the POST method on/api/servicetemplates/windows URI.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the following properties.
Name Type Notes
BootImageId String ID of boot image to use.
ComputeVlanIds StringTrunk VLAN IDs to be applied to attachedphysical Ethernet switch ports.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Optional array of details per each existingvolume to attach. These volumes will beattached to hosts deployed by thistemplate.
StorageSystemId StringID of the storage system where theexisting volume is to be found.
VolumeId StringID of the existing volume as designatedby UCP. This is different from the LUNnumber.
StorageSystemPortIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will determine best ports.
BootUnattendFileLocation String
Boot unattend file location and name.This can be obtainedwith the GETmethod on: /api/servers/images/{IMAGEID} where imageId is the bootimage Id for this template.
BootVolumePoolId String Pool in which to create the boot volume.
BootVolumeSizeInBytes Float Size of boot volume.
BootVolumeStorageSystemId StringStorage system Id. Obtain with GETmethod on: api/storagesystems.
ImageUnattendFileLocation String
Image unattend file location and name.This can be obtainedwith the GETmethod on: /api/servers/images/{IMAGEID} where imageId is the bootimage Id for this template.
Chapter 2: UCP Director resources 799UCP Director API Reference
Service Template Resources
Name Type Notes
VolumesToCreateArray ofCollections
Optional array of volumes that should becreated and attached to servers deployedby this template.
PoolId String Pool in which to create the volume.
VolumeSizeInBytes Float Size of volume to create.
StorageSystemId String ID of the storage system.
StorageSystemPortIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will automatically select thebest ports.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Make a windows template, attaching existing volumesIn this example, a Windows service template is created and existingvolumes are attached. These volumes will be attached to any server thatapplies this template.
Request HeaderPOST https://ucpmanagement.ucp.local/api/servicetemplates/windowsHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"BootImageId": "9","ComputeVlanIds": "27","Name": "WindowsTemplate","VolumesToAttach": [{"StorageSystemId": "93040480","VolumeId": "10","StorageSystemPortIds": ["CTL0-C","CTL0-D","CTL0-E","CTL0-F"]},{"StorageSystemId": "93040480","VolumeId": "12","StorageSystemPortIds": ["CTL0-C","CTL0-D",
800 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"CTL0-E","CTL0-F"]},{"StorageSystemId": "93040480","VolumeId": "14","StorageSystemPortIds": ["CTL0-C","CTL0-D","CTL0-E","CTL0-F"]}],"BootUnattendFileLocation":"\\\\10.21.24.247\\REMINST\\Boot\\x64\\Windows\\BootUnattendFiles\\Windows2012-StdServer-BootUnattend.xml","BootVolumePoolId": "1","BootVolumeSizeInBytes": 214748364800,"BootVolumeStorageSystemId": "93040480","ImageUnattendFileLocation":"\\\\10.21.24.247\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\TemplateWin2K8R2-HFC-StdServer.xml","VolumesToCreate": [
]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Create service template". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
List Windows service templates
This HTTP request uses the GET method on the/api/servicetemplates/windows URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
All Windows service templates are returned.
Example: List Windows service templates
This example lists all Windows service templates.
Chapter 2: UCP Director resources 801UCP Director API Reference
Service Template Resources
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/windows
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response BodySee Example: Get Windows service template by ID.
Get Windows service template
This HTTP request uses the GET method on the/api/servicetemplates/windows/{SERVICETEMPLATEID} URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
The specified Windows service template is returned.
This example returns a specified windows service template.
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/windows/3
Request BodyThe body of this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response Body{"Id": "3","ResourceType": "ServiceTemplate","GlobalResourceId": "inst.UCP-12346.svctmplt.3","InstanceId": "UCP-12346","Links": [{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.3&relation=self"},{
802 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.3&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.3&relation=self%7Csubcomponent"}],"BootImageId": "5","BootImageName": "Windows Server 2012 R2 SERVERSTANDARD","BootImageType": "Windows","ComputeVlanIds": "98","Name": "WindowsTemplate","ServiceTemplateType": "Windows","BootUnattendFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Windows\\BootUnattendFiles\\WindowsR22012StdServerBootUnattend.xml","BootVolumePoolId": "1","BootVolumeSizeInBytes": 42949672960,"BootVolumeStorageSystemId": "93042296","ImageUnattendFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\TemplateWindows2012StdServerImageUnattend.xml"}
Chapter 2: UCP Director resources 803UCP Director API Reference
Service Template Resources
Edit Windows service template
This HTTP request uses the PUT method on the/api/servicetemplates/windows/{SERVICETEMPLATEID} URI.
The template type is specified in the URI. UCP will validate the suppliedvalues against the OS type.
Note that the unchanged existing values of the service template must besubmitted again along with any changed values. For example, if thetemplate currently specifies VolumesToAttach, it must be resubmittedwhen editing the template, otherwise, the values are deleted from theservice template.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the following properties.
Name Type Notes
BootImageId String ID of boot image to use
ComputeVlanIds StringTrunk VLAN IDs to be applied to attachedphysical Ethernet switch ports.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Optional array of details per each existingvolume to attach. These volumes will beattached to hosts deployed by thistemplate.
StorageSystemId StringID of the storage system where theexisting volume is to be found.
VolumeId StringID of the existing volume as designatedby UCP. This is different from the LUNnumber.
StorageSystemPortIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will determine best ports.
BootUnattendFileLocation String
Boot unattend file location and name.This can be obtainedwith the GETmethod on: /api/servers/images/{imageId} where imageId is the bootimage Id for this template.
BootVolumePoolId String Pool in which to create the boot volume.
804 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
BootVolumeSizeInBytes Float Size of boot volume.
BootVolumeStorageSystemId StringStorage system Id. Obtain with GETmethod on: api/storagesystems.
ImageUnattendFileLocation String
Image unattend file location and name.This can be obtainedwith the GETmethod on: /api/servers/images/{imageId} where imageId is the bootimage Id for this template
VolumesToCreateArray ofCollections
Optional array of volumes that should becreated and attached to servers deployedby this template.
PoolId String Pool in which to create the volume.
VolumeSizeInBytes Double Size of volume to create.
StorageSystemId String ID of the storage system.
StorageSystemPortIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will automatically select thebest ports.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Edit a Windows templateIn this example, a Windows service template is edited.
Request HeaderPUT https://ucpmanagement.ucp.local/api/servicetemplates/windows/10HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"BootImageId": "6","ComputeVlanIds": "77","Name": "Win2012DC","VolumesToAttach": [
],"BootUnattendFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Windows\\BootUnattendFiles\\Windows2012DatacenterBootUnattend.xml","BootVolumePoolId": "3","BootVolumeSizeInBytes": 214748364800,"BootVolumeStorageSystemId": "53106",
Chapter 2: UCP Director resources 805UCP Director API Reference
Service Template Resources
"ImageUnattendFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\TemplateWindows2012DatacenterImageUnattend.xml","VolumesToCreate": [
]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Update service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Apply Windows service template
This HTTP request uses the POST method on thehttps://ucpmanagement.ucp.local/api/servicetemplates/windows/{SERVICETEMPLATEID}/servers API.
Templates may only be applied to servers which are in the appropriatestate. Servers may be:
• Off with no server profile applied and no storage
• Off with a non-hypervisor server profile applied and no storage. Payloadmust reapply same server profile
In vCenter, the UCP System Administrator privilege is required.
Request body
The items in the following table must be supplied in the request body.
Name Type Notes
TargetServersArray ofCollections
Array of server IDs, each with a serverprofile ID.
ServerId StringID of the server to which the servicetemplate will be applied.
ServerProfileId NumberID of the server profile that should beapplied (or reapplied) to the above server.
Response body
806 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Apply a Windows service template to two serversRequest HeaderPOSThttps://ucpmanagement.ucp.local/api/servicetemplates/windows/9/serversHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"TargetServers":[ {"ServerId":"adaadd1d-8ff3-11e1-a013-b14256e36145","ServerProfileId":19},{"ServerId":"a87788f9-9093-11e1-a6a5-a0c2cccb9995","ServerProfileId":20} ]
}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Apply Windows service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Create ESXi host service template
This public HTTP request uses the POST method on/api/servicetemplates/esxistateless URI. It creates an ESXi standaloneservice template.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the following properties.
Name Type Notes
BootImageId StringID of the ESXi image to load. This is astateless image deployed by vSphere’sAuto Deploy.
Chapter 2: UCP Director resources 807UCP Director API Reference
Service Template Resources
Name Type Notes
ComputeVlanIds String
Id or range of VLAN Ids to be used byvirtual machines. These are Trunk VLANIDs that will be added to the appropriatevirtual and physical switch ports.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Array of existing volumes to attach.(Optional) Use GET /api/storagesystems/{STORAGESYSTEMID}/volumes
StorageSystemId StringStorage system ID where existingvolumes are to be found
VolumeId StringThe ID of the volume as assigned by UCP.(Not the LUN number).
StorageSystemPortIdsArray ofStrings
Comma separated list of storage ports.(Optional.) If not specified, UCP choosesthe best storage system ports.
VolumesToCreateArray ofCollections
Optional collection of volumes to createand attach to hosts when the template isdeployed. These may be VMFS datastoresor raw volumes. Each of the followingparameter-value pairs must be repeatedfor each volume to create.
PoolId StringStorage pool in which to create thevolume.
VolumeSizeInBytes Float Size of volume to create.
ShouldFormat BooleanWhether or not to format the volume as aVMFS datastore.
StorageSystemId StringStorage system ID in which to create thevolume.
StorageSystemPortIdsArray ofStrings
Comma separated list of storage ports.(Optional.) If not specified, UCP choosesthe best storage system ports.
VolumeName String
Name for the datastore. Required when“ShouldFormat” is true. Each volumename should be unique. Leave this “null”when “ShouldFormat” is false.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
808 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Example: Create new ESXi host service template with volumes to createIn this example, a new ESXi host service template is created. The templatewill create one datastore and one raw volume optimized for Linux and attachthese to hosts that are deployed with this template.
Request HeaderPOST https://ucpmanagement.ucp.local/api/servicetemplates/esxistatelessHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"BootImageId":"2","ComputeVlanIds":"100","Name":"ESXiHost","VolumesToCreate":[{"PoolId":"2","VolumeSizeInBytes":214748364800,"ShouldFormat":true,"StorageSystemId":"93042296","StorageSystemPortIds":null,"VolumeName":"Volume1"},{"PoolId":"2","VolumeSizeInBytes":214748364800,"ShouldFormat":false,"StorageSystemId":"93042296","StorageSystemPortIds":null,"VolumeName":null}]}
Response HeaderHTTP/1.1 200 OK
Response BodyThe system executes a job named “Create service template". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
List ESXi host service templates
This HTTP request uses the GET method on the/api/servicetemplates/esxistateless URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
Chapter 2: UCP Director resources 809UCP Director API Reference
Service Template Resources
All ESXi host service templates are returned.
Example: List ESXi host service templates
This example lists all ESXiStateless service templates.
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/esxistateles
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response BodySee Example: Get ESXi host service template by ID
Get ESXi host service template
This HTTP request uses the GET method on the/api/servicetemplates/esxistateless/{SERVICETEMPLATEID} URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
The specified ESXi host service template is returned.
Example: Get ESXi host service template by ID
This example returns the specified ESXi host service template.
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/esxistateless/2
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "2","ResourceType": "ServiceTemplate","GlobalResourceId": "inst.UCP-12346.svctmplt.2","InstanceId": "UCP-12346","Links": [{"Rel": "collection",
810 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"Href": "https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.2&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.2&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.2&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.2&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.2&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.2&relation=self%7Csubcomponent"}],"BootImageId": "2","BootImageName": "HitachiESXiImage-520HB2","BootImageType": "ESXiStateless","ComputeVlanIds": "100","Name": "ESXiHost","ServiceTemplateType": "EsxiStateless",}
Chapter 2: UCP Director resources 811UCP Director API Reference
Service Template Resources
Edit ESXi host service template
This HTTP request uses the PUT method on the/api/servicetemplates/esxistateless/{SERVICETEMPLATEID} URI.
Note that the unchanged existing values of the service template must besubmitted again along with any changed values. For example, if thetemplate currently specifies VolumesToAttach, it must be resubmittedthese when editing the template, otherwise, the values are deleted from theservice template.
In vCenter, this requires UCP System Administrator privilege.
The request body consists of the properties in the following chart.
Name Type Notes
BootImageId StringID of the ESXi image to load. This is astateless image deployed by vSphere’sAuto Deploy.
ComputeVlanIds String
Id or range of VLAN Ids to be used byvirtual machines. These are Trunk VLANIDs that will be added to the appropriatevirtual and physical switch ports.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Array of existing volumes to attach.(Optional) Use GET /api/storagesystems/{STORAGESYSTEMID}/volumes
StorageSystemId StringStorage system ID where existingvolumes are to be found
VolumeId StringID of the existing volume as assigned byUCP. This is different from the LUNnumber.
StorageSystemPortIdsArray ofStrings
Comma separated list of storage ports.(Optional.) If not specified, UCP choosesthe best storage system ports.
812 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
VolumesToCreateArray ofCollections
Optional collection of volumes to createand attach to hosts when the template isdeployed. These may be VMFS datastoresor raw volumes. Each of the followingparameter-value pairs must be repeatedfor each volume to create.
PoolId StringStorage pool in which to create thevolume.
VolumeSizeInBytes Float Size of volume to create.
ShouldFormat BooleanWhether or not to format the volume as aVMFS datastore.
StorageSystemId StringStorage system ID in which to create thevolume.
StorageSystemPortIdsArray ofStrings
Comma separated list of storage ports.(Optional.) If not specified, UCP choosesthe best storage system ports.
VolumeName String
Name for the datastore. Required when“ShouldFormat” is true. Each volumename should be unique. Leave this “null”when “ShouldFormat” is false.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Modify ESXi host service templateAn ESXi host service template is edited in this example.
Request HeaderPUT https://ucpmanagement.ucp.local/api/servicetemplates/esxistateless/5HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"BootImageId": "1","ComputeVlanIds": "27,29","Name": "ESXiHostServiceTemplate","VolumesToAttach": [{"StorageSystemId":"93040480","VolumeId":"12","IntendedUseImageType":"Windows","StorageSystemPortIds":[]
Chapter 2: UCP Director resources 813UCP Director API Reference
Service Template Resources
}],"VolumesToCreate": [{
"IntendedUseImageType": "EsxiStateless","PoolId": "2","VolumeSizeInBytes": 140949672960,"ShouldFormat": true,"StorageSystemId": "93040480","StorageSystemPortIds": ["CTL0-C","CTL1-C","CTL0-D","CTL1-D"],"VolumeName": "Datastore05"}]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Update service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Apply ESXi host service template
This HTTP request uses the POST method on thehttps://ucpmanagement.ucp.local/api/servicetemplates/esxistateless/{SERVICETEMPLATEID}/servers API.
Templates may only be applied to servers which are in the appropriatestate. Servers may be:
• Off with no server profile applied and no storage.
• Off with a hypervisor server profile applied and no storage. Payload mustreapply same server profile.
• On, with hypervisor server profile applied, no storage attached, ESXi inmaintenance mode, host is not in a cluster.
In vCenter, the UCP System Administrator privilege is required.
Request body
814 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
The item in the following table must be supplied in the request body.
Name Type Notes
TargetServersArray ofCollections
Array of server IDs, each with a serverprofile ID.
ServerId StringID of the server to which the servicetemplate will be applied.
ServerProfileId NumberID of the server profile that should beapplied (or reapplied) to the above server.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Apply an ESXi host service template to two serversIn this example, an ESXi stand-alone host service template is applied to twoservers.
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/servicetemplates/esxistateless/1/serversHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"TargetServers":[ {"ServerId":"adaadd1d-8ff3-11e1-a013-b4903ba328b1","ServerProfileId":6},{"ServerId":"a87788f9-9093-11e1-b9a0-a0c1baa492d0","ServerProfileId":7} ]
}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Apply ESXi standalone servicetemplate". The properties for jobs can be viewed in Common response dataunder UCP Director Resources.
Chapter 2: UCP Director resources 815UCP Director API Reference
Service Template Resources
Create ESXi cluster service template
This public HTTP request uses the POST method on/api/servicetemplates/esxistatelesscluster URI.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the following properties.
Name Type Notes
BootImageId StringId of the ESXi image to load. This is astateless image. Value is always requiredwhen making templates.
ComputeVlanIds String
Id or range of VLAN Ids to use for virtualmachine traffic. These are Trunk VLANIDs. Do not supply this value if a VDS isnamed.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Array of existing volumes to attach. IfSDRS is enabled, all volumes will beplaced in the SDRS cluster. Therefore, allvolumesmust be datastores. Use GET/api/storagesystems/{storageSystemId}/volumes
StorageSystemId StringStorage system ID where existingvolumes are to be found
VolumeId StringThe ID of the volume as assigned by UCP.(Not the LUN number).
StorageSystemPortIdsArray ofStrings
List of SAN ports. If not specified, UCP willselect the best ports
AutomateStorageDrs Boolean
Whether to automate storage DRS I/Ometrics. Automated I/Ometrics must befalse when the Storage Cluster’s pool isHDT. Only supply this value whenpayload specifies “true” forCreateStorageCluster, EnableStorageDrsand EnableStorageDrsIOMetric
816 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
CreateStorageCluster Boolean
Whether to make storage cluster. Whenthis is true, a storage cluster will becreated. Specified volumesmust bedatastores and there must be two ormore. Cannot supply a mix of VMFSdatastores and raw volumes in thispayload. Other SDRS settings areoptional: AutomateStorageDrs,EnableStorageDrs,EnableStorageDrsIOMetric.
DistributedSwitchId String
Id obtained from GET /api/platform/virtualmanagers/{virtualManagerId}/virtualdistributedswitches. Serverswhich apply this template will be added tothis Virtual Distributed Switch. Whensupplying this value, also supply existingport group names for Management andvMotion.
EnableDistributedResourceScheduler BooleanWhether to enable DRS. This refers toDRS on the host cluster.
EnableHighAvailability BooleanWhether to enable HA. This refers to HighAvailability features on the host cluster.
EnableStorageDrs BooleanOptionally enables DRS on the storagecluster. Payloadmust include “true” forCreateStorageCluster
EnableStorageDrsIOMetric Boolean
Enable vSphere DRS I/Ometric. Supplythis value only if CreateStorageCluster is“true” and EnableStorageDrs is true.Ifspecified as “true”, vSphere turns on “I/Ometric for SDRS recommendations.” It isOK to enable this for both HDT and HDPpools. But, if the pool is HDT, do not‘Automate’ the I/Ometrics. See“AutomateStorageDrs” above.
FailoverCpuPercentage Int32Failover CPU reservation. Percentage ofcluster CPU resources reserved as failoverspare capacity.
FailoverRamPercentage Int32Failover RAM reservation. Percentage ofcluster RAM resources reserved asfailover spare capacity.
Chapter 2: UCP Director resources 817UCP Director API Reference
Service Template Resources
Name Type Notes
HostProfileId String
Id of the host profile. A copy of this hostprofile will be made for the cluster thatthis template creates. Use GET/api/virtualmanagers/{virtualManagerId}/hostprofiles
ManagementPortGroupName String
Specify a value for this parameter onlywhen the service template should utilizean existing VDS. In such case, supplyinga value for the “DistributedSwitchId” isalso required. Be sure to use the exactname of the management port groupused by the specified existing VDS.
VMotionPortGroupName String
Specify a value for this parameter onlywhen the service template should utilizean existing VDS. In such case, supplyinga value for the “DistributedSwitchId” isalso required. Be sure to use the exactname of the vMotion port group used bythe specified existing VDS.
VmotionVlanId String
VLAN ID used by vMotion traffic. Leavethis value blank if “DistributedSwitchId”and “ManagementPortGroupName” havebeen specified.
VolumesToCreateArray ofCollections
Datastores to be created. List of volumesto create. These may be VMFS datastoresor raw volumes. When SDRS cluster is tobe created, all VolumesToCreate must beVMFS datastores and there must be twoor more.
PoolId StringStorage pool in which to create thevolume.
VolumeSizeInBytes Float Size of volume to create
ShouldFormat BooleanFormat the datastore as VMFS. Value is“true”.
StorageSystemId StringStorage system ID in which to create thevolume.
StorageSystemPortIdsArray ofStrings
Comma separated list of storage ports.(Optional)
VolumeName StringName for the datastore.Required when“ShouldFormat” is true. Each volumename should be unique.
Response body
818 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Create ESXi cluster service templateThe cluster made by this template will use an existing VDS, will have twodatastores attached and formed into an SDRS storage cluster.
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/servicetemplates/esxistatelessclusterHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"BootImageId": "2","Name": "HAClusterTemplate","AutomateStorageDrs": true,"CreateCluster": true,"CreateStorageCluster": true,"DistributedSwitchId": "dvs-74","EnableDistributedResourceScheduler": true,"EnableHighAvailability": true,"EnableStorageDrs": true,"EnableStorageDrsIOMetric": true,"FailoverCpuPercentage": 25,"FailoverRamPercentage": 25,"HostProfileId": "hostprofile-1","ManagementPortGroupName": "dvHostManagement","VMotionPortGroupName": "dvvMotion","VolumesToCreate": [{"PoolId": "2","VolumeSizeInBytes": 536870912000,"ShouldFormat": true,"StorageSystemId": "93042296","StorageSystemPortIds": null,"VolumeName": "ClusterDatastore1"},{"PoolId": "2","VolumeSizeInBytes": 536870912000,"ShouldFormat": true,"StorageSystemId": "93042296","StorageSystemPortIds": null,"VolumeName": "ClusterDatastore2"}]}
Response HeaderHTTP/1.1 202 Accepted
Chapter 2: UCP Director resources 819UCP Director API Reference
Service Template Resources
Response BodyThe system executes a job named “Create service template".
The properties for jobs can be viewed in Common response data under UCPDirector Resources.
List ESXi cluster service templates
This HTTP request uses the GET method on the/api/servicetemplates/esxistatelesscluster URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
All ESXi cluster service templates are returned.
Example: List ESXi cluster service templates
This example lists all ESXi cluster service templates.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/servicetemplates/esxistatelesscluster
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response BodySee Example: Get ESXi cluster service template by ID.
Get ESXi cluster service template
This HTTP request uses the GET method on the/api/servicetemplates/esxistatelesscluster/{SERVICETEMPLATEID} URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
The specified ESXi cluster service template is returned.
820 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Example: Get ESXi cluster service template by ID
This example returns the specified ESXi cluster service template.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/servicetemplates/esxistatelesscluster/6
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "6","ResourceType": "ServiceTemplate","GlobalResourceId": "inst.UCP-12346.svctmplt.6","InstanceId": "UCP-12346","Links": [{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.6&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.6&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.6&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.6&relation=self"},{
Chapter 2: UCP Director resources 821UCP Director API Reference
Service Template Resources
"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.6&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.6&relation=self%7Csubcomponent"}],"BootImageId": "1","BootImageName": "HitachiESXiImage-520HB1","BootImageType": "ESXiStateless","ComputeVlanIds": null,"Name": "HAClusterTemplate","ServiceTemplateType": "EsxiStatelessCluster","AutomateStorageDrs": true,"CreateStorageCluster": true,"DistributedSwitchId": "dvs-74","EnableDistributedResourceScheduler": true,"EnableHighAvailability": true,"EnableStorageDrs": true,"EnableStorageDrsIOMetric": true,"FailoverCpuPercentage": 25,"FailoverRamPercentage": 25,"HostProfileId": "hostprofile-1","ManagementPortGroupName": "dvHostManagement","VmotionPortGroupName": "dvvMotion","VmotionVlanId": null}
Edit ESXi cluster service template
This HTTP request uses the PUT method on the/api/servicetemplates/esxistatelesscluster/{SERVICETEMPLATEID} URI.
Note that the unchanged existing values of the service template must besubmitted again along with any changed values. For example, if thetemplate currently specifies VolumesToAttach, they must be resubmittedwhen editing the template, otherwise, the values are deleted from theservice template.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the properties in the following chart.
822 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
BootImageId StringId of the ESXi image to load. This is astateless image. Value is always requiredwhen making templates.
ComputeVlanIds String
Id or range of VLAN Ids to use for virtualmachine traffic. These are Trunk VLANIDs. Do not supply this value if a VDS isnamed.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Array of existing volumes to attach. IfSDRS is enabled, all volumes will beplaced in the SDRS cluster. Therefore, allvolumesmust be datastores. Use GET/api/storagesystems/{storageSystemId}/volumes.
StorageSystemId StringStorage system ID where existingvolumes are to be found
VolumeId StringThe ID of the volume as assigned by UCP.(Not the LUN number).
StorageSystemPortIdsArray ofStrings
List of SAN ports. If not specified, UCP willselect the best ports.
AutomateStorageDrs Boolean
Whether to automate storage DRS I/Ometrics. Automated I/Ometrics must befalse when the Storage Cluster’s pool isHDT.
CreateStorageCluster Boolean
Whether to make storage cluster. Whenthis is true, a storage cluster will becreated. Specified volumesmust bedatastores and there must be two ormore. Cannot supply a mix of VMFSdatastores and raw volumes in thispayload. Other SDRS settings areoptional: AutomateStorageDrs,EnableStorageDrs,EnableStorageDrsIOMetric.
Chapter 2: UCP Director resources 823UCP Director API Reference
Service Template Resources
Name Type Notes
DistributedSwitchId String
Id obtained from GET /api/platform/virtualmanagers/{virtualManagerId}/virtualdistributedswitches. Serverswhich apply this template will be added tothis Virtual Distributed Switch. Whensupplying this value, also supply existingport group names for Management andvMotion.
EnableDistributedResourceScheduler BooleanWhether to enable DRS. This refers toDRS on the host cluster.
EnableHighAvailability BooleanWhether to enable HA. This refers to HighAvailability features on the host cluster.
EnableStorageDrs BooleanOptionally enables DRS on the storagecluster. Payloadmust include “true” forCreateStorageCluster
EnableStorageDrsIOMetric Boolean
Supply this value only ifCreateStorageCluster is “true” andEnableStorageDrs is true. If “true”,vSphere enables “I/Ometric for SDRSrecommendations.” It is OK to enablethis for both HDT and HDP pools. But, ifthe pool is HDT, do not ‘Automate’ theI/Ometrics. See “AutomateStorageDrs”above.
FailoverCpuPercentage Int32Failover CPU reservation. Percentage ofcluster CPU resources reserved as failoverspare capacity.
FailoverRamPercentage Int32Failover RAM reservation. Percentage ofcluster RAM resources reserved asfailover spare capacity.
HostProfileId String
Id of the host profile. A copy of this hostprofile will be made for the cluster thatthis template creates. Use GET/api/virtualmanagers/{virtualManagerId}/hostprofiles
824 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
ManagementPortGroupName String
Specify a value for this parameter onlywhen the service template should utilizean existing VDS. In such case, supplyinga value for the “DistributedSwitchId” isalso required. Be sure to use the exactname of the management port groupused by the specified existing VDS.Whencreating a new VDS, this parameter maybe left out or set to null in the payload.
VmotionPortGroupName String
Specify a value for this parameter onlywhen the service template should utilizean existing VDS. In such case, supplyinga value for the “DistributedSwitchId” isalso required. Be sure to use the exactname of the vMotion port group used bythe specified existing VDS.When creatinga new VDS, this parameter may be leftout or set to null in the payload.
VmotionVlanId String
VLAN ID used by vMotion traffic. Leavethis value blank if “DistributedSwitchId”and “ManagementPortGroupName” havebeen specified.
VolumesToCreateArray ofCollections
List of volumes to create. These may beVMFS datastores or raw volumes. WhenSDRS cluster is to be created, allVolumesToCreate must be VMFSdatastores and there must be two ormore.
PoolId StringStorage pool in which to create thevolume.
VolumeSizeInBytes Float Size of volume to create
ShouldFormat BooleanFormat the datastore as VMFS. Value is“true”. When true, VolumeName is alsorequired.
StorageSystemId StringStorage system ID in which to create thevolume.
StorageSystemPortIdsArray ofStrings
Comma separated list of storage ports.(Optional)
VolumeName StringName for the datastore.Required when“ShouldFormat” is true. Each volumename should be unique.
Chapter 2: UCP Director resources 825UCP Director API Reference
Service Template Resources
Apply cluster service template
See section "Create cluster with service template" on page 56.
Create custom service template
This HTTP request uses the POST method on the/api/servicetemplates/custom URI.
Custom service templates prepare servers for manual OS deployment. Thetemplate adjusts the networking and applies a non-hypervisor serverprofile.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the following properties.
Name Type Notes
BootImageId String
Id of the boot image. Although customtemplates do not actually have a boot volume,there is an id associated with the concept of acustom template’s boot volume. To find the Idof the custom image, use the GETmethod on/api/servers/images?ImageType=Custom.
ComputeVlanIds String
Compute VLAN ID or range of VLAN Ids. ThisID or range of IDs will be applied to thephysical switch ports used by the servers thatapply this template.
Name String Name of the custom service template.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Make custom service templateThis example shows how to create a custom service template.
Request HeaderPOST https://ucpmanagement.ucp.local/api/servicetemplates/customHTTP/1.1 Content-Type: application/json;charset=utf-8
Request Body{
826 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"BootImageId": "2","ComputeVlanIds": "27","Name": "CustomServiceTemplate",}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Create service template". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
List custom service templates
This HTTP request uses the GET method on the/api/servicetemplates/custom URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
All custom service templates are returned.
Example: List custom service templates
This example lists all custom service templates.
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/custom
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response BodySee Example: Get custom service template by ID
Get custom service template
This HTTP request uses the GET method on the /api/servicetemplates/{SERVICETEMPLATEID}custom URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
The specified custom service template is returned.
Chapter 2: UCP Director resources 827UCP Director API Reference
Service Template Resources
Example: Get custom service template by ID
This example returns the specified custom service template.
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/custom/4
Request BodyThe body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body{"Id": "4","ResourceType": "ServiceTemplate","GlobalResourceId": "inst.UCP-12346.svctmplt.4","InstanceId": "UCP-12346","Links": [{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.4&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.4&relation=self"},{"Rel": "events.subcomponent",
828 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.4&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12346.svctmplt.4&relation=self%7Csubcomponent"}],"BootImageId": "3","BootImageName": "Custom Image","BootImageType": "Custom","ComputeVlanIds": "100","Name": "CustomTemplate","ServiceTemplateType": "Custom",}
Edit custom service template
This HTTP request uses the PUT method on the/api/servicetemplates/custom/{SERVICETEMPLATEID} URI.
Note that the unchanged existing values of the service template must besubmitted again along with any changed values.
The UCP System Administrator privilege is required.
The items in the following table must be supplied in the request body.
Name Type Notes
BootImageId String
Id of the boot image. Although customtemplates do not actually have a boot volume,there is an id associated with the concept of acustom template’s boot volume. To find the Idof the custom image, use the GETmethod on/api/servers/images?ImageType=Custom.
ComputeVlanIds String
Compute VLAN ID or range of VLAN Ids. ThisID or range of IDs will be applied to thephysical switch ports used by the servers thatapply this template.
Name String Name of the custom service template.
Response body
Chapter 2: UCP Director resources 829UCP Director API Reference
Service Template Resources
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Edit a custom service template
In this example, a custom service template is edite.
Request HeaderPUT https://ucpmanagement.ucp.local/api/servicetemplates/custom/8HTTP/1.1Content-Type: application/json;charset=utf-8
Request Body{"BootImageId": "2","ComputeVlanIds": "30-31","Name": "CustomServiceTemplate",}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Update service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Apply custom service template
This HTTP request uses the POST method on thehttps://ucpmanagement.ucp.local/api/servicetemplates/custom/{SERVICETEMPLATEID}/servers API.
Templates may only be applied to servers which are in the appropriatestate. Servers may be:
• Off with no server profile applied and no storage.
• Off with a non-hypervisor server profile applied and no storage. Payloadmust reapply same server profile.
In vCenter, the UCP System Administrator privilege is required.
Request body
The item in the following table must be supplied in the request body.
830 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
TargetServersArray ofCollections
Array of server IDs, each with a serverprofile ID.
ServerId StringID of the server to which the servicetemplate will be applied.
ServerProfileId Int32ID of the server profile that should beapplied (or reapplied) to the above server.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Apply a custom service template to two serversIn this example, a custom service template is applied to two servers alongwith a specified server profile for each server. The native VLAN ID will bedictated by the server profile, but trunk VLAN IDs are configured accordingto the service template.
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/servicetemplates/custom/18/serversHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"TargetServers":[ {"ServerId":"adaadd1d-8ff3-11e1-a013-b4903bd02ab0","ServerProfileId":13},{"ServerId":"a87788f9-9093-11e1-b9b0-a0c1bac2fa31","ServerProfileId":14} ]
}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Apply custom service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Chapter 2: UCP Director resources 831UCP Director API Reference
Service Template Resources
Create Windows Hyper-V service template
This HTTP request uses the POST method on the/api/servicetemplates/windowshyperv URI.
This template type is appropriate when the virtual platform manager isSCVMM.
In vCenter, the UCP System Administrator privilege is required.
The request body consists of the following properties.
Name Type Notes
BootImageId StringTrunk VLAN IDs to be applied to attachedphysical Ethernet switch ports.
ComputeVlanIds StringName of the template. Namemust beunique.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Array of existing volumes to attach.IfSDRS is enabled, all volumes will be placedin the SDRS cluster. Therefore, allvolumesmust be datastores. Use GET/api/storagesystems/{storageSystemId}/volumes
StorageSystemId StringID of the existing volume as designatedby UCP. This is different from the LUNnumber.
VolumeId StringThe ID of the volume as assigned by UCP(Not the LUN number).
StorageSystemPortsIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will determine best ports.
BootUnattendFileLocation String
Boot unattend file location and name.This can be obtainedwith the GETmethod on: /api/servers/images/{IMAGEID} where imageId is the bootimage Id for this template.
BootVolumePoolId String Pool in which to create the boot volume.
BootVolumeSizeInBytes Float Size of boot volume.
832 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
BootVolumeStorageSystemId StringStorage system Id. Obtain with GETmethod on: api/storagesystems.
ImageUnattendFileLocation String
Image unattend file location and name.This can be obtainedwith the GETmethod on: /api/servers/images/{IMAGEID} where imageId is the bootimage Id for this template.
VolumesToCreateArray ofCollections
Optional array of volumes that should becreated and attached to servers deployedby this template.
PoolId String Pool in which to create the volume.
VolumeSizeInBytes Float Size of volume to create.
StorageSystemId String ID of the storage system.
StorageSystemPortIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will automatically select thebest ports.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Make Windows Hyper-V service templateIn this example, a Windows Hyper-V service template is created.
Request HeaderPOST https: //10.21.24.243/api/servicetemplates/windowshpervHTTP/1.1 Content-Type: application/json;charset=utf-8
Request Body{"BootImageId": "9","ComputeVlanIds": "27","Name": "WindowsHyperV","VolumesToAttach": [ ],"BootUnattendFileLocation":"\\\\10.21.24.247\\REMINST\\Boot\\x64\\Windows\\BootUnattendFiles\\Windows2012-StdServer-BootUnattend.xml","BootVolumePoolId": "1","BootVolumeSizeInBytes": 214748364800,"BootVolumeStorageSystemId": "93040480","ImageUnattendFileLocation":"\\\\10.21.24.247\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\TemplateWin2K8R2-HFC-StdServer.xml","VolumesToCreate":
Chapter 2: UCP Director resources 833UCP Director API Reference
Service Template Resources
[{"PoolId":"3","VolumeSizeInBytes":107374182400,"StorageSystemId":"53106","StorageSystemPortIds":["CL1-C","CL2-C","CL3-C","CL4-C"]}]
}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Create service template". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
List Windows Hyper-V service templates
This HTTP request uses the GET method on the/api/servicetemplates/windowshyperv URI.
In vCenter, the UCP View privilege is required.
The request body of this request must be empty.
All windows hyperv service templates are returned.
Example: List Windows Hyper-V service templates
This example lists all Windows Hyper-V service templates.
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/windowshyperv
Request Body
The body of this request must be empty.
Response HeaderStatus: 200 OK
Response BodySee Example: Get Windows Hyper-V service template by ID
Get Windows Hyper-V service template
This HTTP request uses the GET method on the/api/servicetemplates/windowshyperv/{SERVICETEMPLATEID} URI.
In vCenter, the UCP View privilege is required.
834 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
The request body of this request must be empty.
The specified Windows Hyper-V service template is returned.
Example: Get Windows Hyper-V service template by ID
This example returns the specified Windows Hyper-V service template.
Request HeaderGET https://ucpmanagement.ucp.local/api/servicetemplates/windowshyperv/1
Request Body
The body of this request must be empty.
Response HeaderStatus: 200 OK
Response Body[{"Id": "1","ResourceType": "ServiceTemplate","GlobalResourceId": "inst.UCP-12333.svctmplt.1","InstanceId": "UCP-12333","Links": [{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12333.svctmplt.1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12333.svctmplt.1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplate&targetId=inst.UCP-12333.svctmplt.1&relation=self%7Csubcomponent"},{"Rel": "events.self",
Chapter 2: UCP Director resources 835UCP Director API Reference
Service Template Resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12333.svctmplt.1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12333.svctmplt.1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplate&targetId=inst.UCP-12333.svctmplt.1&relation=self%7Csubcomponent"}],"BootImageId": "9","BootImageName": " Windows Server 2012 R2 DATACENTER ","BootImageType": "Windows","ComputeVlanIds":"100-101","Name": "Windows HyperV Service Template1","ServiceTemplateType": "WindowsHyperV","BootUnattendFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Windows\\BootUnattendFiles\\Windows2012R2DatacenterBootUnattend.xml","BootVolumePoolId": "1","BootVolumeSizeInBytes": 52949672960,"BootVolumeStorageSystemId": "310007","ImageUnattendFileLocation":"\\\\wds\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\Windows2012R2DatacenterImageUnattend.xml"}]
Edit Windows Hyper-V service template
This HTTP request uses the PUT method on the/api/servicetemplates/windowshyperv/{SERVICETEMPLATEID} URI.
Note that the unchanged existing values of the service template must besubmitted again along with any changed values.
In vCenter, the UCP System Administrator privilege is required.
The items in the following table must be supplied in the request body.
836 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
BootImageId StringTrunk VLAN IDs to be applied to attachedphysical Ethernet switch ports.
ComputeVlanIds StringName of the template. Namemust beunique.
Name StringName of the template. Namemust beunique.
VolumesToAttachArray ofCollections
Array of existing volumes to attach. IfSDRS is enabled, all volumes will be placedin the SDRS cluster. Therefore, allvolumesmust be datastores. Use GET/api/storagesystems/{storageSystemId}/volumes
StorageSystemId StringID of the existing volume as designatedby UCP. This is different from the LUNnumber.
VolumeId StringThe ID of the volume as assigned by UCP.(Not the LUN number).
StorageSystemPortsIds StringList of storage system ports to use. If notspecified, UCP will determine best ports.
BootUnattendFileLocation String
Boot unattend file location and name.This can be obtainedwith the GETmethod on: /api/servers/images/{IMAGEID} where imageId is the bootimage Id for this template.
BootVolumePoolId String Pool in which to create the boot volume.
BootVolumeSizeInBytes Float Size of boot volume.
BootVolumeStorageSystemId StringStorage system Id. Obtain with GETmethod on: api/storagesystems.
ImageUnattendFileLocation String
Image unattend file location and name.This can be obtainedwith the GETmethod on: /api/servers/images/{IMAGEID} where imageId is the bootimage Id for this template.
VolumesToCreateArray ofCollections
Optional array of volumes that should becreated and attached to servers deployedby this template.
PoolId String Pool in which to create the volume.
VolumeSizeInBytes Float Size of volume to create.
StorageSystemId String ID of the storage system.
StorageSystemPortIdsArray ofStrings
List of storage system ports to use. If notspecified, UCP will automatically select thebest ports.
Chapter 2: UCP Director resources 837UCP Director API Reference
Service Template Resources
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Edit a Windows Hyper-V service templateIn this example, a Windows Hyper-V service template is modified.
Request HeaderPUT https: //10.21.24.243/api/servicetemplates/windowshperv/8HTTP/1.1 Content-Type: application/json;charset=utf-8
Request Body{"BootImageId": "9","ComputeVlanIds": "27","Name": "WindowsHyperV","VolumesToAttach": [ ],"BootUnattendFileLocation":"\\\\10.21.24.247\\REMINST\\Boot\\x64\\Windows\\BootUnattendFiles\\Windows2012-StdServer-BootUnattend.xml","BootVolumePoolId": "1","BootVolumeSizeInBytes": 214748364800,"BootVolumeStorageSystemId": "93040480","ImageUnattendFileLocation":"\\\\10.21.24.247\\REMINST\\Boot\\x64\\Windows\\ImageUnattendFiles\\TemplateWin2K8R2-HFC-StdServer.xml","VolumesToCreate":[{"PoolId":"3","VolumeSizeInBytes":107374182400,"StorageSystemId":"53106","StorageSystemPortIds":["CL1-C","CL2-C","CL3-C","CL4-C"]}]}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Create service template". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
Example: Apply a Windows Hyper-V service template to a serverIn this example, a Windows Hyper-V service template is used deployed toone server. A server profile is specified for the server. The destination forthe host in SCVMM is the “All Hosts” folder.
838 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/servicetemplates/windowshyperv/2/serversHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"TargetServers":[{"ServerId":"f3469584-56f1-4149-914e-48414c331d12","ServerProfileId":24}],"HostGroupId":"All Hosts","Password":"Kum0@pur@1nS","UserName":"ucp\\ucpadmin"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Apply Hyper-V service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Apply Windows Hyper-V service template
This HTTP request uses the POST method on thehttps://ucpmanagement.ucp.local/api/servicetemplates/windowshyperv/{SERVICETEMPLATEID}/servers API.
Templates may only be applied to servers which are in the appropriatestate. Servers may be:
• Off with no server profile applied and no storage.
• Off with a hypervisor server profile applied and no storage. Payload mustreapply same server profile.
In vCenter, the UCP System Administrator privilege is required.
Request body
The item in the following table must be supplied in the request body.
Chapter 2: UCP Director resources 839UCP Director API Reference
Service Template Resources
Name Type Notes
TargetServersArray ofCollections
Array of server IDs, each with a serverprofile ID.
ServerId StringID of the server to which the servicetemplate will be applied.
ServerProfileId Int32ID of the server profile that should beapplied (or reapplied) to the above server.
HostGroupId StringId of the host group in SCVMMwhere thehost should be placed.
Password String Local host administrator password.
UserName String Local host administrator user name.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Apply a Windows Hyper-V service template to a serverIn this example, a Windows Hyper-V service template is used deployed toone server. A server profile is specified for the server. The destination forthe host in SCVMM is the “All Hosts” folder.
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/servicetemplates/windowshyperv/2/serversHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"TargetServers":[{"ServerId":"f3469584-56f1-4149-914e-48414c331d12","ServerProfileId":24}],"HostGroupId":"All Hosts","Password":"Kum0@pur@1nS","UserName":"ucp\\ucpadmin"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Apply Hyper-V service template". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
840 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Delete service template
This HTTP request uses the DELETE method on the /api/servicetemplates/{SERVICETEMPLATEID} URI, where the {SERVICETEMPLATEID} is the idof the template to delete.
In vCenter, the UCP System Administrator privilege is required.
The request body of this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Delete service templateIn this example, service template with ID 7 is deleted.
Request HeaderDELETE https://ucpmangement.ucp.local/api/servicetemplates/7HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderStatus: 202 Accepted
Response BodyThe system executes a job named “Delete service template". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
Copy service template
This HTTP request uses the POST method on the /api/servicetemplates/{SERVICETEMPLATEID}/?action=copy API
In vCenter, the UCP System Administrator privilege is required.
The items in the following table must be supplied in the request body.
Name Type Notes
Name String New name for the copied service template.
Response body
Chapter 2: UCP Director resources 841UCP Director API Reference
Service Template Resources
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
Example: Copy a service templateThis API clones the template specified by Id in the URI and supplies a newname to the copy.
Request HeaderPOST https://ucpmanagement.ucp.local/api/templates/12/?action=copy
Request body{"Name":"CopiedCustomTemplate"}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Clone service template". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
List volumes associated with a service template
This HTTP request uses the GET method on the /api/servicetemplates/{SERVICETEMPLATEID}/servicetemplatevolumes API.
In vCenter, the UCP View privilege is required.
The body of this request must be empty.
Per volume, this API returns the same data as shown below under Getdetails for a volume associated with a template.
Example: List volumes from specific serice template
The volumes associated with this template happen to be existing volumesto attach manually selected storage array ports.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/servicetemplates/15/servicetemplatevolumesHTTP/1.1Content-Type: application/json;charset=utf-8
Request BodyThe body of this request must be empty.
842 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "17","ResourceType": "ServiceTemplateVolume","GlobalResourceId": "inst.UCP-123-456-789.svctmplt.15.vol.17","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates\/15\/servicetemplatevolumes\/17"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates\/15\/servicetemplatevolumes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=self"},{"Rel": "events.subcomponent",
Chapter 2: UCP Director resources 843UCP Director API Reference
Service Template Resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=self%7Csubcomponent"}],"CapacitySizeInBytes": 13687091200,"PoolId": "1","ServiceTemplateId": "15","ShouldFormat": false,"StorageSystemId": "92240401","StorageSystemPortIds": ["CTL1-F","CTL0-F","CTL1-E","CTL0-E"],"StorageSystemVolumeInformation": {"Id": "100","ResourceType": "StorageVolume","GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.92240401.vol.100","InstanceId": "UCP-123-456-789","MonitorState": null,"ArrayGroup": -1,"AttachedServerIds": [
],"Chassis": 0,"IsBootVolume": false,"IsReplicatedVolume": false,"LDev": 100,"Name": "","PoolId": "1","StorageSystemId": "92240401","TotalCapacityInBytes": 13687091200,"UsedCapacityInBytes": 0,"UsedPercentage": 0"VolumeType":"HDP"},"VolumeName": ""},{"Id": "18","ResourceType": "ServiceTemplateVolume","GlobalResourceId": "inst.UCP-123-456-789.svctmplt.15.vol.18",
844 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates\/15\/servicetemplatevolumes\/18"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates\/15\/servicetemplatevolumes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.18&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.18&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.18&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.18&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.18&relation=subcomponent"},{"Rel": "events.all",
Chapter 2: UCP Director resources 845UCP Director API Reference
Service Template Resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.18&relation=self%7Csubcomponent"}],"CapacitySizeInBytes": 21474836480,"PoolId": "0","ServiceTemplateId": "15","ShouldFormat": false,"StorageSystemId": "92240401","StorageSystemPortIds": ["CTL1-F","CTL0-F","CTL1-E","CTL0-E"],"StorageSystemVolumeInformation": {"Id": "101","ResourceType": "StorageVolume","GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.92240401.vol.101","InstanceId": "UCP-123-456-789","MonitorState": null,"ArrayGroup": -1,"AttachedServerIds": [
],"Chassis": 0,"IsBootVolume": false,"IsReplicatedVolume": false,"LDev": 101,"Name": "","PoolId": "0","StorageSystemId": "92240401","TotalCapacityInBytes": 21474836480,"UsedCapacityInBytes": 0,"UsedPercentage": 0"VolumeType":"HDP"},"VolumeName": ""}]
Get details for a volume associated with a service template
This HTTP request uses the GET method on the /api/servicetemplates/{SERVICETEMPLATEID}/servicetemplatevolumes/{SERVICETEMPLATEVOLUMEID} URI.
In vCenter, the UCP View privilege is required.
846 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
The body of this request must be empty.
The response body contains the following properties about the servicetemplate volume.
Name Type Notes
(Common properties) See Common properties.
CapacitySizeInBytes FloatSize of the volume or datastore.Applicable to both VolumesToCreate andVolumesToAttach.
PoolId StringStorage pool where the volume is.Applicable to both VolumesToCreate andVolumesToAttach.
ServiceTemplateId String Id of the service template.
ShouldFormat BooleanWhether to format as VMFS. This is Falsefor VolumesToAttach.Could be False orTrue for VolumesToCreate.
StorageSystemId StringId of the storage system. Applieswhether it is an existing volume toattach or a new volume to create.
StorageSystemPortIdsArray ofStrings
SAN ports. If specified, these are the SANports the host should use whenaddressing the volume. Applies to eithervolume type.
StorageSystemVolumeInformation CollectionCollection of information about existingVolumesToAttach.
Id StringUCP’s Id for this volume. Only applicableto existing VolumesToAttach.
ResourceType StringType of resource as applicable for thisvolume.
GlobalResourceId String Global resource Id for this volume.
InstanceId StringId of the UCP instance having thisvolume in inventory.
MonitorState Collection Always null for service template volumes.
Array ofCollections
Array of monitor indicators for themonitor state.
StringName of the monitor indicator to bedisplayed on the UI.
String State of indicator.
String Type of indicator.
Chapter 2: UCP Director resources 847UCP Director API Reference
Service Template Resources
Name Type Notes
String Name of monitor indicator.
Array ofStrings
Global sub-resource Id for this monitorindicator.
StringType of the sub-resource as applicable forthis monitor indicator.
StringSetting of the monitor mode for thevolume.
Int32 Number of Error states for the volume.
Int32Number of Not Applicable states for thevolume.
Int32 Number of OK states for the volume.
Int32Number of Unknown states for thevolume.
Int32Number of Warning states for thevolume.
StringState of resrouce as applicable for thismonitor state.
StringType of resource as applicable for thismonitor state.
StringUpdated Date and Time for the monitorstate.
ArrayGroup Int32Array group in which the volume resides.Only applicable to existingVolumesToAttach.
AttachedServerIdsArray ofStrings
List of servers currently attached to thevolume. Only applicable to existingVolumesToAttach.
Chassis Int32Sorage array chassis Id. Only applicableto existing VolumesToAttach.
IsBootVolume Boolean Whether the volume is the Boot Volume.
IsReplicatedVolume Boolean Whether the volume is replicated.
LDev Int32Logical Device Id as reported by theHitachi SAN. Only applicable to existingVolumesToAttach.
Name String
Name of volume. If existing volume is aVMFS datastore, this is its name.VolumesToCreate uses “VolumeName”instead.
848 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
Name Type Notes
PoolId StringStorage system pool Id where thevolume is. Only applicable to existingVolumesToAttach.
StorageSystemId StringStorage System Id. Storage system idwhere the volume is located.
TotalCapacityInBytes FloatSize of the volume. Only applicable toexisting VolumesToAttach.
UsedCapacityInBytes FloatTotal amount of volume used. Onlyapplicable to existing VolumesToAttach.
UsedPercentage Int32Percentage of volume used. Onlyapplicable to existing VolumesToAttach.
VolumeType StringType of volume, which depends upon thetype of storage pool the volume is in.Applicable to existing volumes to attach.
ArrayGroup Int32Array group in which the volume resides.Only applicable to existingVolumesToAttach.
AttachedServerIds ObjectList of servers currently attached to thevolume. Only applicable to existingVolumesToAttach.
Chassis Int32Sorage array chassis Id. Only applicableto existing VolumesToAttach.
LDev Int32Logical Device Id as reported by theHitachi SAN. Only applicable to existingVolumesToAttach.
Name String
Name of volume. If existing volume is aVMFS datastore, this is its name.VolumesToCreate uses “VolumeName”instead.
PoolId StringStorage system pool Id where thevolume is. Only applicable to existingVolumesToAttach.
StorageSystemId StringStorage System Id. Storage system idwhere the volume is located.
TotalCapacityInBytes DoubleSize of the volume. Only applicable toexisting VolumesToAttach.
UsedCapacityInBytes DoubleTotal amount of volume used. Onlyapplicable to existing VolumesToAttach.
UsedPercentage Int32Percentage of volume used. Onlyapplicable to existing VolumesToAttach.
Chapter 2: UCP Director resources 849UCP Director API Reference
Service Template Resources
Name Type Notes
VolumeType StringType of volume, which depends upon thetype of storage pool the volume is in.Applicable to existing volumes to attach.
VolumeName StringApplicable to VolumesToCreate whenthey are to be formatted as VMFSdatastores for ESXi hosts.
Example: Get a volume from a specified service template – datastore tocreate
In this example, the service template volume is specified with Id 20 and isattached to service template 17. In this case, the volume is not previouslyexisting but will be created when template is deployed.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/servicetemplates/17/servicetemplatevolumes/20 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "20","ResourceType": "ServiceTemplateVolume","GlobalResourceId": "inst.UCP-123-456-789.svctmplt.17.vol.20","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates\/17\/servicetemplatevolumes\/20"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates\/17\/servicetemplatevolumes"},{"Rel": "jobs.self",
850 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.17.vol.20&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.17.vol.20&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.17.vol.20&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.17.vol.20&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.17.vol.20&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.17.vol.20&relation=self%7Csubcomponent"}],"CapacitySizeInBytes": 214748364800,"PoolId": "0","ServiceTemplateId": "17","ShouldFormat": true,"StorageSystemId": "92240401","StorageSystemPortIds": null,"StorageSystemVolumeInformation": null,"VolumeName": "Vol2"}
Chapter 2: UCP Director resources 851UCP Director API Reference
Service Template Resources
Example: Get a volume from specified service template – attach existingvolume
This example requests service template volume Id 17 from service template15. It happens to be an existing volume to attach with manually specifiedSAN ports.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/servicetemplates/15/servicetemplatevolumes/17 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body of this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "17","ResourceType": "ServiceTemplateVolume","GlobalResourceId": "inst.UCP-123-456-789.svctmplt.15.vol.17","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates\/15\/servicetemplatevolumes\/17"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/servicetemplates\/15\/servicetemplatevolumes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=subcomponent"},
852 Chapter 2: UCP Director resources
UCP Director API Reference
Service Template Resources
{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=ServiceTemplateVolume&targetId=inst.UCP-123-456-789.svctmplt.15.vol.17&relation=self%7Csubcomponent"}],"CapacitySizeInBytes": 13687091200,"PoolId": "1","ServiceTemplateId": "15","ShouldFormat": false,"StorageSystemId": "92240401","StorageSystemPortIds": ["CTL1-F","CTL0-F","CTL1-E","CTL0-E"],"StorageSystemVolumeInformation": {"Id": "100","ResourceType": "StorageVolume","GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.92240401.vol.100","InstanceId": "UCP-123-456-789","MonitorState": null,"ArrayGroup": -1,"AttachedServerIds": [
],"Chassis": 0,"IsBootVolume": false,
Chapter 2: UCP Director resources 853UCP Director API Reference
Service Template Resources
"IsReplicatedVolume": false,"LDev": 100,"Name": "","PoolId": "1","StorageSystemId": "92240401","TotalCapacityInBytes": 13687091200,"UsedCapacityInBytes": 0,"UsedPercentage": 0"VolumeType":"HDP"},"VolumeName": ""}
Storage system resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List storage systems" onthe facing page
GET /api/storagesystems UCP View
"Get storage system" onpage 856
GET/api/storagesystems/{STORAGESYSTEMID}
UCP View
"List parity groups" onpage 864
GET/api/storagesystems/{STORAGESYSTEMID}/paritygroups
UCP View
"Get parity group by ID"on page 867
GET/api/storagesystems/{STORAGESYSTEMID}/parityGroups/{PARITYGROUPID}
UCP View
"List physical devices" onpage 870
GET/api/storagesystems/{STORAGESYSTEMID}/physicalDevices
UCP View
"List storage systempools" on page 873
GET/api/storagesystems/{STORAGESYSTEMID}/pools
UCP View
"Get storage system pool"on page 875
GET/api/storagesystems/{STORAGESYSTEMID}/pools/{POOLID}
UCP View
"List storage systemports" on page 880
GET/api/storagesystems/{STORAGESYSTEMID}/ports
UCP View
"Get storage system port"on page 884
GET/api/storagesystems/{STORAGESYSTEMID}/ports/{PORTID}
UCP View
854 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Request Method URIvCenterPrivilege
"List storage systemprocessors" on page 887
GET/api/storagesystems/{STORAGESYSTEMID}/processors
UCP View
"List storage systemvolumes" on page 891
GET/api/storagesystems/{STORAGESYSTEMID}/volumes
UCP View
"Get storage systemvolume" on page 901
GET/api/storagesystems/{STORAGESYSTEMID}/volumes/{VOLUMEID}
UCP View
"Create storage systemvolume" on page 905
POST/api/storagesystems/{STORAGESYSTEMID}/volumes
UCP StorageAdministrator
"Delete storage systemvolume" on page 906
DELETE/api/storagesystems/{STORAGESYSTEMID}/volumes/{VOLUMEID}
UCP StorageAdministrator
"Expand storage systemvolume" on page 906
POST/api/storagesystems/{STORAGESYSTEMID}/volumes/{VOLUMEID}/expand
UCP StorageAdministrator
"Refresh storage systeminventory" on page 907
POST /api/storagesystems/refreshUCP StorageAdministrator
List storage systems
This HTTP request uses the GET method on the /api/storagesystems URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of an arrayproperties about the storage system. UCP supports exactly one storagesystem at this time. The properties are detailed under the heading "Getstorage system" on the next page.
Example: List storage systems
Request HeaderGET https://ucpmanagement.ucp.local/api/storagesystems HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Chapter 2: UCP Director resources 855UCP Director API Reference
Storage system resources
Response BodySee "Get storage system" below.
Get storage system
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID} URI, where {STORAGESYSTEMID} specifies the IDof the storage system that is to be returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following table.
Name Type Notes
(Common properties) See Common properties
MonitorState Collection Collection of monitorstate metadata.
GlobalResourceId StringGlobally unique resource Id of the storagesystem.
MonitorIndicators CollectionCollection of monitor indicators withcurrent values.
DisplayName String Display name of the monitor indicator.
IndicatorState String State of the indicator.
IndicatorType String Type if indicator.
Name String Name of the indicator.
SubGlobalResourceIds String List of global Ids of sub resources, if any.
SubResourceType String Type of sub resource, if any.
MonitorMode String
The mode for reporting the SNMP trapsfrom the storage system. Values:
• Report
• Off
• Monitor
NumErrors Int32Number of errors totaled fromSubGlobalResourceIds.
NumNotApplicables Int32Number of NAmessages totaled fromSubGlobalResourceIds.
856 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Name Type Notes
NumOks Int32Number of OKmessages totaled fromSubGlobalResourceIds.
NumUnknowns Int32Number of Unknown messages totaledfrom SubGlobalResourceIds.
NumWarnings Int32Number of Warnings totaled fromSubGlobalResourceIds.
ResourceState String Overall state of the storage system.
ResourceType StringAlways “StorageSystem” for the storagesystem.
UpdateDateTime DateTimeLast time that an aggregatedmonitorstatus was compiled.
AllocatedSpaceInBytes DoubleThe size of the allocated space in thestorage system, in bytes.
ArrayFamily StringThe family of the storage system. i.e. R700or D850
ComponentStatuses CollectionCollection of the following twometrics foreach of several components in the storagesystem.
Name String Name of the component.
Status String Status of the component.
ControllerVersion StringThe microcode version of the controller onthe storage system.
FreeSpaceInBytes DoubleThe size of the free space available in thestorage system, in bytes.
MicrocodeVersion StringThe microcode version of the ServiceProcessor of the storage system. Empty forHUS storage systems.
Name String The name of the storage system.
PhysicalSpaceInBytes DoubleThe size of the physical space in thestorage system, in bytes.
ReservedSpaceInBytes DoubleThe size of the reserved space in thestorage system, in bytes.
SerialNumber String The serial number of the storage system.
Status String The status of the storage system.
SystemIpAddressesArray ofStrings
The IP addresses of the storage system.
SystemType String The type of the storage system.
UnallocatedSpaceInBytes DoubleThe size of the unallocated space in thestorage system, in bytes.
Chapter 2: UCP Director resources 857UCP Director API Reference
Storage system resources
Example: Get a storage system
Request HeaderGET https://ucpmanagement.ucp.local/api/storagesystems/53106 HTTP/1.1
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "53106","ResourceType": "StorageSystem","GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.53106","InstanceId": "UCP-123-456-789","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/53106"},{"Rel": "collection","Href": "https:\/\/ucpmanagement.ucp.local\/api\/storagesystems"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageSystem&targetId=inst.UCP-123-456-789.stor.1.ss.53106&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageSystem&targetId=inst.UCP-123-456-789.stor.1.ss.53106&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageSystem&targetId=inst.UCP-123-456-789.stor.1.ss.53106&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageSystem&targetId=inst.UCP-123-456-789.stor.1.ss.53106&relation=self"},
858 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageSystem&targetId=inst.UCP-123-456-789.stor.1.ss.53106&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageSystem&targetId=inst.UCP-123-456-789.stor.1.ss.53106&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.UCP-123-456-789.stor.1.ss.53106","MonitorIndicators": [{"DisplayName": "DKC Battery","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKCBattery","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKC Cache","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKCCache","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKC Cache Switch","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKCCacheSwitch","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKC Environment","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKCEnvironment","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKC Fan","IndicatorState": "Ok",
Chapter 2: UCP Director resources 859UCP Director API Reference
Storage system resources
"IndicatorType": "Health","Name": "DKCFan","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKC Power Supply","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKCPowerSupply","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKC Processor","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKCProcessor","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKC Shared Memory","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKCSharedMemory","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKU Drive","IndicatorState": "Warning","IndicatorType": "Health","Name": "DKUDrive","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKU Environment","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKUEnvironment","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "DKU Fan","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKUFan","SubGlobalResourceIds": null,"SubResourceType": null},
860 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
{"DisplayName": "DKU PowerSupply","IndicatorState": "Ok","IndicatorType": "Health","Name": "DKUPowerSupply","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Cache Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "CachePerformance","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Processors","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Processors","SubGlobalResourceIds": [
],"SubResourceType": "StorageProcessor"},{"DisplayName": "Ports","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Ports","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.53106.port.CL1-C","inst.UCP-123-456-789.stor.1.ss.53106.port.CL3-C","inst.UCP-123-456-789.stor.1.ss.53106.port.CL2-C","inst.UCP-123-456-789.stor.1.ss.53106.port.CL5-C","inst.UCP-123-456-789.stor.1.ss.53106.port.CL4-C","inst.UCP-123-456-789.stor.1.ss.53106.port.CL7-C","inst.UCP-123-456-789.stor.1.ss.53106.port.CL6-C","inst.UCP-123-456-789.stor.1.ss.53106.port.CL8-C"],"SubResourceType": "StoragePort"},{"DisplayName": "Pools","IndicatorState": "Ok","IndicatorType": "Composite","Name": "Pools","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.53106.pool.3","inst.UCP-123-456-789.stor.1.ss.53106.pool.9"],"SubResourceType": "StoragePool"
Chapter 2: UCP Director resources 861UCP Director API Reference
Storage system resources
},{"DisplayName": "Journals","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Journals","SubGlobalResourceIds": [
],"SubResourceType": "StorageJournal"},{"DisplayName": "Parity Groups","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "ParityGroups","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.53106.pg.X2222-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2102-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2218-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2079-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2319-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2201-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2276-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2083-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2223-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2101-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2255-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2138-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2252-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2248-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2274-1","inst.UCP-123-456-789.stor.1.ss.53106.pg.X2122-1"],"SubResourceType": "StorageParityGroup"},{"DisplayName": "Volumes","IndicatorState": "NotApplicable","IndicatorType": "Composite","Name": "Volumes","SubGlobalResourceIds": ["inst.UCP-123-456-789.stor.1.ss.53106.vol.14897","inst.UCP-123-456-789.stor.1.ss.53106.vol.14887","inst.UCP-123-456-789.stor.1.ss.53106.vol.14877","inst.UCP-123-456-789.stor.1.ss.53106.vol.14867","inst.UCP-123-456-789.stor.1.ss.53106.vol.14857","inst.UCP-123-456-789.stor.1.ss.53106.vol.14966","inst.UCP-123-456-789.stor.1.ss.53106.vol.14956","inst.UCP-123-456-789.stor.1.ss.53106.vol.14946","inst.UCP-123-456-789.stor.1.ss.53106.vol.14936","inst.UCP-123-456-789.stor.1.ss.53106.vol.14926","inst.UCP-123-456-789.stor.1.ss.53106.vol.14893",
862 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"inst.UCP-123-456-789.stor.1.ss.53106.vol.14883","inst.UCP-123-456-789.stor.1.ss.53106.vol.14873","inst.UCP-123-456-789.stor.1.ss.53106.vol.14863","inst.UCP-123-456-789.stor.1.ss.53106.vol.14853","inst.UCP-123-456-789.stor.1.ss.53106.vol.195"],"SubResourceType": "StorageVolume"}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 231,"NumOks": 13,"NumUnknowns": 0,"NumWarnings": 1,"ResourceState": "Warning","ResourceType": "StorageSystem","UpdatedDateTime": "12\/12\/2013 7:30:14 PM +00:00"},"AllocatedSpaceInBytes": 21383353100288,"ArrayFamily": "R700","ComponentStatuses": [{"Name": "DKC Battery","Status": "Normal"},{"Name": "DKC Cache","Status": "Normal"},{"Name": "DKC Cache Switch","Status": "Normal"},{"Name": "DKC Environment","Status": "Normal"},{"Name": "DKC Fan","Status": "Normal"},{"Name": "DKC Power Supply","Status": "Normal"},{"Name": "DKC Processor","Status": "Normal"},{"Name": "DKC Shared Memory","Status": "Normal"
Chapter 2: UCP Director resources 863UCP Director API Reference
Storage system resources
},{"Name": "DKU Drive","Status": "Normal"},{"Name": "DKU Environment","Status": "Normal"},{"Name": "DKU Fan","Status": "Normal"},{"Name": "DKU Power Supply","Status": "Normal"}],"ControllerVersion": "70-05-19-00\/00","FreeSpaceInBytes": 12467222347776,"MicrocodeVersion": "70-05-09\/00","Name": "[email protected]","PhysicalSpaceInBytes": 72988826979328,"ReservedSpaceInBytes": 44385162821632,"SerialNumber": "53106","Status": "Normal","SystemIpAddresses": ["10.20.90.67"],"SystemType": "VSP","UnallocatedSpaceInBytes": 7220311057408}}
List parity groups
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/paritygroups URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
All parity groups in the specified storage system are returned. Each paritygroup contains the same values shown in the chart under the heading Getparity groups by ID below.
864 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Example: List all parity groups on the storage system
Request HeaderGEThttps://ucpmanagement.ucp.local/api/storagesystems/53106/paritygroupsHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "1-9","ResourceType": "StorageParityGroup","GlobalResourceId": "inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9","InstanceId": "V2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/53106\/paritygroups\/1-9"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/53106\/paritygroups"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=subcomponent"},{"Rel": "jobs.all",
Chapter 2: UCP Director resources 865UCP Director API Reference
Storage system resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9","MonitorIndicators": [{"DisplayName": "Parity Group Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ParityGroupPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageParityGroup","UpdatedDateTime": "12\/16\/2013 8:05:58 PM +00:00"},"ArrayGroup": 128,"Chassis": 1,
866 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"ParityGroupType": "Normal","StorageSystemId": "53106"}…]
Get parity group by ID
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/paritygroups/{PARITYGROUPID} URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body contains the following information regarding thespecified parity group.
Name Type Notes
ArrayGroup Int32 Array group in which the parity group resides.
Chassis Int32Storage chassis in which the parity groupresides.
ParityGroupType String
Type of the parity group. Values:
• NotApplicable
• Normal
• External
• SnapshotAndThinImage
• HitachiDynamicProvisioningAndTiering
• HusHitachiDynamicProvisioningAndTiering
StorageSystemId StringStorage system in which the parity groupresides.
Example: Get a parity group
In this example, the specified parity group is returned.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/storagesystems/53106/paritygroups/1-9 HTTP/1.1Content-Type: application/json; charset=utf-8
Chapter 2: UCP Director resources 867UCP Director API Reference
Storage system resources
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "1-9","ResourceType": "StorageParityGroup","GlobalResourceId": "inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9","InstanceId": "V2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/53106\/paritygroups\/1-9"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/53106\/paritygroups"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=self%7Csubcomponent"},{"Rel": "events.self",
868 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageParityGroup&targetId=inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.V2Production-123-456-789.stor.1.ss.53106.pg.1-9","MonitorIndicators": [{"DisplayName": "Parity Group Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ParityGroupPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageParityGroup","UpdatedDateTime": "12\/16\/2013 8:15:53 PM +00:00"},"ArrayGroup": 128,"Chassis": 1,"ParityGroupType": "Normal","StorageSystemId": "53106"]
Chapter 2: UCP Director resources 869UCP Director API Reference
Storage system resources
List physical devices
This HTTP request uses the GET method on the /api/storagesystems/{STORAGE SYSTEMID}/physicalDevices URI.
The physical disks are listed in the response body.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
Per each physical device, the following information is listed.
Name Type Notes
ArrayGroup Int32The array group in which the physicaldevice is found.
CapacityInKb Double Capacity of the physical device in KB.
Chassis Int32Storage chassis in which the physicaldevice resides.
Column Int32Column where the physical device isinstalled.
DiskType String Type of physical disk.
Row Int32 Row where the physical device is installed.
Rpm Int32 Revolutions per minute (speed) of the disk.
StorageSystemId StringStorage system in which the physicaldevice is installed.
Example: List the physical devices on a HUS150
The API for retrieving physical devices is not implemented for VSP, VSPG1000, or HUS-VM storage systems.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/storagesystems/92240401/physicaldevices HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
870 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Response Body[{"Id": "0.0","ResourceType": "StoragePhysicalDevice","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.pd.0..0","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/physicaldevices"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePhysicalDevice&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pd.0..0&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePhysicalDevice&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pd.0..0&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePhysicalDevice&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pd.0..0&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePhysicalDevice&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pd.0..0&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePhysicalDevice&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pd.0..0&relation=subcomponent"},{
Chapter 2: UCP Director resources 871UCP Director API Reference
Storage system resources
"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePhysicalDevice&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pd.0..0&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.pd.0..0","MonitorIndicators": [{"DisplayName": "Physical Device Health","IndicatorState": "Ok","IndicatorType": "Health","Name": "PhysicalDeviceHealth","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Physical Device Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PhysicalDevicePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePhysicalDevice","UpdatedDateTime": "12\/16\/2013 10:18:33 PM +00:00"},"ArrayGroup": 74,"CapacityInKb": 561819342,"Chassis": 0,"Column": 0,"DiskType": 4,"Row": 0,"Rpm": 10000,"StorageSystemId": "92240401"}]
872 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
List storage system pools
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/pools URI, where {STORAGESYSTEMID} specifiesthe ID of the storage system with the pools that are to be returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body consists of an array of information for each storage pool.Properties of storage pools are detailed under the heading "Get storagesystem pool" on page 875.
Example: List a storage system’s pools
In this example, the list of storage pools is returned.
Request HeaderGET https://ucpmanagement.ucp.local/api/storagesystems/53106/poolsHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "0","ResourceType": "StoragePool","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/pools\/0"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/pools"
Chapter 2: UCP Director resources 873UCP Director API Reference
Storage system resources
},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0","MonitorIndicators": [{"DisplayName": "Pool Usage","IndicatorState": "Ok","IndicatorType": "Health",
874 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"Name": "PoolUsage","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Pool Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PoolPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePool","UpdatedDateTime": "12\/16\/2013 10:48:33 PM +00:00"},"CapacityInBytes": 3446711255040,"CurrentSubscriptionPercentage": null,"Name": null,"Status": "Normal","StorageSystemId": "92240401","StorageSystemPoolDiskDetails": [{"CapacityInBytes": 3446711255039.9985,"DiskType": "Sas","PercentageAllocated": 100,"Rpm": 10000}],"SubscribedCapacityInBytes": 1309461708800,"SubscriptionLimitPercentage": 130,"Type": "Hdp","UsedCapacityInBytes": 54760833024,"UsedPercentage": 1}]
Get storage system pool
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/pools/{POOLID} URI, where{STORAGESYSTEMID} specifies the ID of the storage system with the poolthat is to be returned and {POOLID} specifies the ID of that pool.
Chapter 2: UCP Director resources 875UCP Director API Reference
Storage system resources
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following table.
Name Type Notes
CapacityInBytes DoubleThe physical capacity of the pool, inbytes.
CurrentSubscriptionPercentage Int32The over provisioning percentage of thepool. A percentage.
Name String
Name of the storage pool. Usually nullexcept in the case of HTI pools. The nameis supplied by the technician who createdthe pool (outside of UCP).
Status String
The status of the pool. Values:
• NotApplicable
• Normal
• Blocked
• OverThreshold
• Warning
• Shrinking
StorageSystemId StringThe ID of the storage system hosting thepool.
StorageSystemPoolDiskDetails CollectionCollection of information about the disksin the pool.
CapacityInBytes Double The capacity of the disk, in bytes.
DiskType String
The type of disk. Values:
• External
• Sata
• Sas
• Ssd
• Unknown
876 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Name Type Notes
PercentageAllocated Int32The percentage capacity of the disk basedon the total pool capacity.
Rpm Int32The revolutions per minute of the disk.Null for external disk types.
SubscribedCapacityInBytes DoubleThe subscribed capacity of the pool, inbytes.
SubscriptionLimitPercentage Int32The upper subscription limit used tomonitor over provisioning. A percentage.
ThroughputInMBps Int32Write speed to the storage device inMegabytes per second.
Type String
The tieringmode of the pool. Values:
• Hdp
• Hdt
UsedCapacityInBytes Double The used capacity of the pool.
UsedPercentage Double The usage rate of the pool. A percentage.
Example: Get a pool from a storage system
In this example, the specified pool is returned.
Request HeaderGET https://ucpmanagement.ucp.local/api/storagesystems/53106/pools/3HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "0","ResourceType": "StoragePool","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/pools\/0"
Chapter 2: UCP Director resources 877UCP Director API Reference
Storage system resources
},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/pools"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePool&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0&relation=self%7Csubcomponent"}],"MonitorState": {
878 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.pool.0","MonitorIndicators": [{"DisplayName": "Pool Usage","IndicatorState": "Ok","IndicatorType": "Health","Name": "PoolUsage","SubGlobalResourceIds": null,"SubResourceType": null},{"DisplayName": "Pool Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PoolPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 1,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "Ok","ResourceType": "StoragePool","UpdatedDateTime": "12\/16\/2013 11:13:34 PM +00:00"},"CapacityInBytes": 3446711255040,"CurrentSubscriptionPercentage": null,"Status": "Normal","StorageSystemId": "92240401","StorageSystemPoolDiskDetails": [{"CapacityInBytes": 3446711255039.9985,"DiskType": "Sas","PercentageAllocated": 100,"Rpm": 10000}],"SubscribedCapacityInBytes": 1309461708800,"SubscriptionLimitPercentage": 130,"ThroughputInMBps": 63,"Type": "Hdp","UsedCapacityInBytes": 54760833024,"UsedPercentage": 1}
Chapter 2: UCP Director resources 879UCP Director API Reference
Storage system resources
List storage system ports
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/ports URI, where {STORAGESYSTEMID}.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body consists of an array for eachstorage port. Properties for storage ports are detailed under the heading"Get storage system port" on page 884.
Example: List a storage system’s ports
In this example, the storage system ports are listed.
Request HeaderGET https://ucpmanagement.ucp.local/api/storagesystems/92240401/portsHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "CTL1-C","ResourceType": "StoragePort","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/ports\/CTL1-C"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/ports"},
880 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance",
Chapter 2: UCP Director resources 881UCP Director API Reference
Storage system resources
"SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/16\/2013 11:17:45 PM +00:00"},"PortName": "CTL1-C","PortRole": "Target","PortWwn": "50.06.0E.80.10.3A.F4.1A","Speed": "EightGbps","StorageSystemId": "92240401","Type": "Fibre"},{"Id": "CTL1-D","ResourceType": "StoragePort","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-D","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/ports\/CTL1-D"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/ports"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-D&relation=self"},{"Rel": "jobs.subcomponent",
882 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-D&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-D&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-D&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-D&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-D&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-D","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,
Chapter 2: UCP Director resources 883UCP Director API Reference
Storage system resources
"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/16\/2013 11:17:45 PM +00:00"},"PortName": "CTL1-D","PortRole": "Target","PortWwn": "50.06.0E.80.10.3A.F4.1B","Speed": "EightGbps","StorageSystemId": "92240401","Type": "Fibre"}]
Get storage system port
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/ports/{PORTID} URI, where{STORAGESYSTEMID} specifies the ID of the storage system with the portthat is to be returned and {PORTID} is the ID of that port.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following table.
Name Type Notes
PortName String The name of the storage port.
PortRole String
The functional role of the port.
Values:
• Target
• RcuTarget
• Initiator
• External
• Ignore
PortWwn String The world-wide name of the storage port.
Speed StringThe channel speed of the storage port.
Values:
884 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Name Type Notes
• NotApplicable
• Auto
• OneGbps
• TwoGbps
• FourGbps
• EightGbps
• TenGbps
StorageSystemId StringThe ID of the storage system that containsthe storage port.
Type String
The type of the storage port.
Values:
• Lcp
• Fibre
• Scsi
• Ficon
• Nas
• Iscsi
• Fcoe
Example: Get a port on a storage system
In the following example, the specified storage port is returned.
Request HeaderGET https://ucpmanagement.ucp.local/api/storagesystems/53106/ports/CL2-CHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Chapter 2: UCP Director resources 885UCP Director API Reference
Storage system resources
Response Body{"Id": "CTL1-C","ResourceType": "StoragePort","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/ports\/CTL1-C"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/ports"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=self"},{"Rel": "events.subcomponent",
886 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StoragePort&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.port.CTL1-C","MonitorIndicators": [{"DisplayName": "Port Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "PortPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StoragePort","UpdatedDateTime": "12\/16\/2013 11:18:33 PM +00:00"},"PortName": "CTL1-C","PortRole": "Target","PortWwn": "50.06.0E.80.10.3A.F4.1A","Speed": "EightGbps","StorageSystemId": "92240401","Type": "Fibre"}
List storage system processors
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/processors URI.
The body for this request must be empty.
Chapter 2: UCP Director resources 887UCP Director API Reference
Storage system resources
The response contains the following information regarding each processor inthe specified storage system.
Name Type Notes
AdaptorId StringId of the adapter containing the storageprocessor.
ProcessorId String Id of the processor.
StorageSystemId StringStorage system in which the processorresides.
Example: List the storage system processors
This example lists the storage system processors.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/storagesystems/92240401/processorsHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "ctl0-0","ResourceType": "StorageProcessor","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-0","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/processors"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-0&relation=self"},{
888 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-0&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-0&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-0&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-0&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-0&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-0","MonitorIndicators": [{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,
Chapter 2: UCP Director resources 889UCP Director API Reference
Storage system resources
"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageProcessor","UpdatedDateTime": "12\/16\/2013 11:23:17 PM +00:00"},"AdaptorId": null,"ProcessorId": "ctl0-0","StorageSystemId": "92240401"},{"Id": "ctl0-1","ResourceType": "StorageProcessor","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-1","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/processors"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-1&relation=self"},{
890 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageProcessor&targetId=inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-1&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.proc.ctl0-1","MonitorIndicators": [{"DisplayName": "Processor Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "ProcessorPerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageProcessor","UpdatedDateTime": "12\/16\/2013 11:23:17 PM +00:00"},"AdaptorId": null,"ProcessorId": "ctl0-1","StorageSystemId": "92240401"}…]
List storage system volumes
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/volumes URI, where { STORAGESYSTEMID}specifies the ID of the storage system with the volumes that are to bereturned.
In vCenter, the UCP View privilege is required.
Chapter 2: UCP Director resources 891UCP Director API Reference
Storage system resources
This request optionally accepts the following filter criteria.
Name Type Notes
serverid StringThe ID of the server to which the volumesthat will be returnedmust be attached.
clusterid StringThe ID of the cluster to which the volumesthat will be returnedmust be attached.
poolid StringThe ID of the storage pool that contains thevolumes which are to be returned.
Response body
The response body consists of an array of information for each volume.Properties of volumes are detailed under the heading "Get storage systemvolume" on page 901.
Example: List all volumes in a storage system
In this example, all volumes in the storage system are returned.
Request HeaderGET https://ucpmanagement.ucp.local/api/storagesystems/66716/volumesHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "64781","ResourceType": "StorageVolume","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.vol.11","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/volumes\/11"},{"Rel": "collection",
892 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/66716\/volumes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.vol.11","MonitorIndicators": [{"DisplayName": "Volume Performance",
Chapter 2: UCP Director resources 893UCP Director API Reference
Storage system resources
"IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/17\/2013 9:20:42 PM +00:00"},"ArrayGroup": 21,"AttachedServerIds": ["420904c6-8fe8-11e1-b8a6-f3397e44dc5d","9547efca-8f49-11e1-87dd-f56064181daf","c0afd1bb-35cb-11e2-a485-fef319a996cc"],"Chassis": 16486,"IsBootVolume": false,"IsReplicatedVolume": false,"LDev": 64781,"Name": "ClusterDS","PoolId": "1","StorageSystemId": "66716","TotalCapacityInBytes": 21474836480,"UsedCapacityInBytes": 1073741824,"UsedPercentage": 40"VolumeType": "HDP"}…]
Example: List all volumes in a storage system pool
In this example, all volumes in the specified pool are returned.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/storagesystems/66716/volumes?poolId=1 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
894 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Response Body[{"Id": "64781","ResourceType": "StorageVolume","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/66716\/volumes\/64781"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/66716\/volumes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self"},{"Rel": "events.subcomponent",
Chapter 2: UCP Director resources 895UCP Director API Reference
Storage system resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/17\/2013 9:24:55 PM +00:00"},"ArrayGroup": 21,"AttachedServerIds": ["420904c6-8fe8-11e1-b8a6-f3397e44dc5d","9547efca-8f49-11e1-87dd-f56064181daf","c0afd1bb-35cb-11e2-a485-fef319a996cc"],"Chassis": 16486,"IsBootVolume": false,"IsReplicatedVolume": false,"LDev": 64781,"Name": "ClusterDS","PoolId": "1","StorageSystemId": "66716","TotalCapacityInBytes": 21474836480,"UsedCapacityInBytes": 8763998208,"UsedPercentage": 40
896 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"VolumeType": "HDP"}…]
Example: List all volumes in a storage system that are attached to a server
Request HeaderGEThttps://ucpmanagement.ucp.local/api/storagesystems/66716/volumes?serverId=420904c6-8fe8-11e1-b8a6-f3397e44dc5d HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "64781","ResourceType": "StorageVolume","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/66716\/volumes\/64781"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/66716\/volumes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=subcomponent"},
Chapter 2: UCP Director resources 897UCP Director API Reference
Storage system resources
{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.66716.vol.64781","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/17\/2013 9:24:55 PM +00:00"},
898 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
"ArrayGroup": 21,"AttachedServerIds": ["420904c6-8fe8-11e1-b8a6-f3397e44dc5d","9547efca-8f49-11e1-87dd-f56064181daf","c0afd1bb-35cb-11e2-a485-fef319a996cc"],"Chassis": 16486,"IsBootVolume": false,"IsReplicatedVolume": false,"LDev": 64781,"Name": "ClusterDS","PoolId": "1","StorageSystemId": "66716","TotalCapacityInBytes": 21474836480,"UsedCapacityInBytes": 8763998208,"UsedPercentage": 40"VolumeType": "HDP"}]
Example: List all volumes in a storage system that are attached to a cluster
In this example, a cluster ID is specified in the URI. All volumes attached tothis cluster are returned.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/storagesystems/66716/volumes?clusterId=domain-c130 HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "64793","ResourceType": "StorageVolume","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.66716.vol.64793","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/66716\/volumes\/64793"},
Chapter 2: UCP Director resources 899UCP Director API Reference
Storage system resources
{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/66716\/volumes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64793&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64793&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64793&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64793&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64793&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64793&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.66716.vol.64793","MonitorIndicators": [
900 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/17\/2013 9:35:17 PM +00:00"},"ArrayGroup": 63,"AttachedServerIds": ["a87788f9-9093-11e1-a6a5-a0c2cccb9995"],"Chassis": 16486,"IsBootVolume": false,"IsReplicatedVolume": false,"LDev": 64793,"Name": "CDF","PoolId": "1","StorageSystemId": "66716","TotalCapacityInBytes": 16106127360,"UsedCapacityInBytes": 880803840,"UsedPercentage": 5"VolumeType": "HDP"}…]
Get storage system volume
This HTTP request uses the GET method on the /api/storagesystems/{STORAGESYSTEMID}/volumes/{VOLUMEID} URI, where{STORAGESYSTEMID} specifies the ID of the storage system with thevolume that is to be returned and {VOLUMEID} is the ID of that volume.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
The response body consists of the properties in the following table.
Chapter 2: UCP Director resources 901UCP Director API Reference
Storage system resources
Name Type Notes
ArrayGroup Int32The array group in which the volume isfound.
AttachedServerIds CollectionCollection of server IDs that the volume isattached to, if any.
Chassis Int32Storage chassis in which the volumeresides.
IsBootVolume Boolean If this volume is boot volume.
IsReplicatedVolume Boolean If this volume is replicate volume.
LDev Int32The LDEV of the volume. Expressed as aninteger value. LDEVmeans Logical DeviceID.
Name String The name of the volume.
PoolId StringThe ID of the pool that contains thevolume.
StorageSystemId StringThe ID of the storage system thatcontains the volume.
TotalCapacityInBytes Double The capacity of the volume, in bytes.
UsedCapacityInBytes Double The used capacity of the volume, in bytes.
UsedPercentage Int32The used percentage of the volume. Apercentage.
VolumeType String
Volume type, which depends on pool type.Values can be:
• HDP• HDT• HTI
Example: Get a volume
In this example, the specified volume is returned.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/storagesystems/66716/volumes/64807HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
902 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Response Body{"Id": "64807","ResourceType": "StorageVolume","GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.vol.11","InstanceId": "v2Production-123-456-789","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/92240401\/volumes\/11"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/storagesystems\/66716\/volumes"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64807&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64807&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64807&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64807&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-
Chapter 2: UCP Director resources 903UCP Director API Reference
Storage system resources
789.stor.1.ss.66716.vol.64807&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=StorageVolume&targetId=inst.v2Production-123-456-789.stor.1.ss.66716.vol.64807&relation=self%7Csubcomponent"}],"MonitorState": {"GlobalResourceId": "inst.v2Production-123-456-789.stor.1.ss.92240401.vol.11","MonitorIndicators": [{"DisplayName": "Volume Performance","IndicatorState": "NotApplicable","IndicatorType": "Performance","Name": "VolumePerformance","SubGlobalResourceIds": null,"SubResourceType": null}],"MonitorMode": "Report","NumErrors": 0,"NumNotApplicables": 1,"NumOks": 0,"NumUnknowns": 0,"NumWarnings": 0,"ResourceState": "NotApplicable","ResourceType": "StorageVolume","UpdatedDateTime": "12\/17\/2013 7:15:09 PM +00:00"},"ArrayGroup": 77,"AttachedServerIds": ["dc62699b-8fbf-11e1-8af8-8d51dd9b5240"],"Chassis": 16486,"IsBootVolume": false,"IsReplicatedVolume": false,"LDev": 64807,"Name": "ABC","PoolId": "1","StorageSystemId": "66716","TotalCapacityInBytes": 17179869184,"UsedCapacityInBytes": 880803840,"UsedPercentage": 5"VolumeType":"HDP"
}
904 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
Create storage system volume
This HTTP request uses the POST method on the /api/storagesystems/{STORAGESYSTEMID}/volumes URI, where storagesystemid specifies theID of the storage system that is to contain the new volume.
In vCenter, the UCP Storage Administrator privilege is required
This request body consists of the properties in the following table.
Name Type Notes
PoolId StringSpecifies the ID of the storage pool that isto contain the new volume.
VolumeLabel StringLabel assigned to the volume in thestorage system.
VolumeSizeInBytes DoubleSpecifies the size of the new volume. Validrange: 1288490188 – 65970693734400bytes (1.12 GB – 59.99 TB).
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Create a new volume in a storage systemIn this example, a volume is created. Volumes created in this manner arenot attached to servers.
Request HeaderPOST https://ucpmanagement.ucp.local/api/storagesystems/92240401/volumesHTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"PoolId": "3","VolumeLabel": "DataVol","VolumeSizeInBytes": 53687091200}
Response HeaderHTTP/1.1 202 Accepted
Chapter 2: UCP Director resources 905UCP Director API Reference
Storage system resources
Response BodyThe system executes a job named “Create a new volume". The propertiesfor jobs can be viewed in Common response data under UCP DirectorResources.
Delete storage system volume
This HTTP request uses the DELETE method on the /api/storagesystems/{STORAGESYSTEMID}/volumes/{VOLUMEID} URI, where{STORAGESYSTEMID} specifies the ID of the storage system from whichvolume is to be deleted and {VOLUMEID} is the ID of that volume.
In vCenter, the UCP Storage Administrator privilege is required
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Remove a volume from a storage systemIn this example, the specified volume is deleted. It must first be detachedfrom all servers.
Request HeaderDELETEhttps://ucpmanagement.ucp.local/api/storagesystems/92240401/volumes/100HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Delete a volume". The properties forjobs can be viewed in Common response data under UCP DirectorResources.
Expand storage system volume
This HTTP request uses the POST method on the /api/storagesystems/{STORAGESYSTEMID}/volumes/{VOLUMEID}/expand URI where{STORAGESYSTEMID} specifies the ID of the storage system with the
906 Chapter 2: UCP Director resources
UCP Director API Reference
Storage system resources
volume that is to be expanded and {VOLUMEID} is the ID of that volume.
In vCenter, the UCP Storage Administrator privilege is required
This request body consists of the properties in the following table.
Name Type Notes
VolumeSizeInBytes Double
Specifies the size of the volume after it isexpanded. Valid range: 1288490188 –65970693734400 bytes (1.12 GB – 59.99TB).Must be at least 107374182 bytes(102.4 MB) larger than the current size.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Expand a volume that is attached to a server
In this example, the specified storage volume is expanded to the sizespecified in the request body.
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/storagesystems/66716/volumes/64807/expand HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"VolumeSizeInBytes": 161061273600}
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Expand the size of an existing volume".The properties for jobs can be viewed in Common response data under UCPDirector Resources.
Refresh storage system inventory
This HTTP request uses the POST method on the/api/storagesystems/refresh URI.
Chapter 2: UCP Director resources 907UCP Director API Reference
Storage system resources
In vCenter, the UCP Storage Administrator privilege is required
The body for this request must be empty.
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from "Get UCP job" onpage 439.
Example: Refresh storage system inventory
In this example, the storage system inventory is refreshed.
Request HeaderPOST https://ucpmanagement.ucp.local/api/storagesystems/refresh HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Refresh storage inventory". Theproperties for jobs can be viewed in Common response data under UCPDirector Resources.
Get syslogThis API is used for searching for keywords within the internal UCP syslog.The start and end times need to span less than two hours. Time isformatted for a 24 hour clock.
This HTTP request uses the GET method on the/monitoring/syslog?startTime={STARTTIME}&endTime={ENDTIME}&keyword={KEYWORD} URI.
In vCenter, the UCP View privilege is required.
The body of this request must be empty.
The response body contains a string value with the requested sysloginformation.
908 Chapter 2: UCP Director resources
UCP Director API Reference
Get syslog
Example: Get actions attempted by unauthorized users
Job history will not contain a record of actions attempted by unauthorizedusers, but the internal syslog will. Therefore, this API is a powerful tool forchecking on users who try to do things outside of their permission set. Thisexample looks for anyone who attempted a denied operation between thespecified start and end times. The example below shows that the networkadmin tried to delete a volume.
Request HeaderGET https://10.21.57.243/monitoring/syslog?startTime=2013/12/1622:00:00&endTime=2013/12/16 23:00:00&keyword=result=DeniedHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body"\u000a2013-12-16T22:42:22.754966Z UCPMANAGEMENT.ucp.local UCP-Orchestrator[10456] INFO: thread:[254] msg:[91413771]user:ucp\\ucpNetworkAdmin ServiceAccount:ucp\\svc_ucp UCPAuthorizationuser=ucp\\ucpNetworkAdmin|sessionId=|operation=DeleteVolume|result=Denied \u000a2013-12-16T22:42:22.879765Z UCPMANAGEMENT.ucp.local UCP-Orchestrator[10456] INFO: thread:[254] msg:[91413842]user:ucp\\ucpNetworkAdmin ServiceAccount:ucp\\svc_ucp UCPAuthorizationuser=ucp\\ucpNetworkAdmin|sessionId=|operation=DeleteVolume|result=Denied \u000a2013-12-16T22:42:49.899249Z UCPMANAGEMENT.ucp.local UCP-Orchestrator[10456] INFO: thread:[72] msg:[91469104]user:ucp\\ucpNetworkAdmin ServiceAccount:ucp\\svc_ucp UCPAuthorizationuser=ucp\\ucpNetworkAdmin|sessionId=|operation=DeleteVolume|result=Denied \u000a2013-12-16T22:47:50.686078Z UCPMANAGEMENT.ucp.local UCP-Monitor[12796] INFO: thread:[68] msg:[93325707]user:ucp\\ucpNetworkAdmin ServiceAccount:ucp\\svc_ucp 2013-12-16T22:42:22.754966Z UCPMANAGEMENT.ucp.local UCP-Orchestrator[10456]INFO: thread:[254] msg:[91413771] user:ucp\\ucpNetworkAdminServiceAccount:ucp\\svc_ucp UCPAuthorizationuser=ucp\\ucpNetworkAdmin|sessionId=|operation=DeleteVolume|result=Denied \u000a2013-12-16T22:47:50.686078Z UCPMANAGEMENT.ucp.local UCP-Monitor[12796] INFO: thread:[68] msg:[93325707]user:ucp\\ucpNetworkAdmin ServiceAccount:ucp\\svc_ucp 2013-12-16T22:42:22.879765Z UCPMANAGEMENT.ucp.local UCP-Orchestrator[10456]INFO: thread:[254] msg:[91413842] user:ucp\\ucpNetworkAdminServiceAccount:ucp\\svc_ucp UCPAuthorization
Chapter 2: UCP Director resources 909UCP Director API Reference
Get syslog
user=ucp\\ucpNetworkAdmin|sessionId=|operation=DeleteVolume|result=Denied \u000a2013-12-16T22:47:50.686078Z UCPMANAGEMENT.ucp.local UCP-Monitor[12796] INFO: thread:[68] msg:[93325707]user:ucp\\ucpNetworkAdmin ServiceAccount:ucp\\svc_ucp 2013-12-16T22:42:49.899249Z UCPMANAGEMENT.ucp.local UCP-Orchestrator[10456]INFO: thread:[72] msg:[91469104] user:ucp\\ucpNetworkAdminServiceAccount:ucp\\svc_ucp UCPAuthorizationuser=ucp\\ucpNetworkAdmin|sessionId=|operation=DeleteVolume|result=Denied \u000a"
Upload firmware bundle into UCPFirmware bundles are used when updating chassis, blades, and switches.The bundles are copied to an internal UCP repository by a service technicianusing this API. Actual firmware updates to hardware resources arescheduled and performed at a later time.
This HTTP request uses the POST method on the/api/updatemanagement/firmwareUpdatePackage API.
The table below includes details for this API.
Method URIvCenterPrivilege
POST /api/updatemanagement/firmwareUpdatePackageUCP SystemAdministrator
Request body
The request body contains a single string value of the update bundle’s pathand file name. Most REST clients will insert escape characters for you. Ifnot, you must type the escape characters as in the following example:
“\\\\10.21.84.251\\CopyRepository\\UCP30_UpdatePackage.zip”
In vCenter, the UCP Administrator privilege is required.
Response body
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job.
910 Chapter 2: UCP Director resources
UCP Director API Reference
Upload firmware bundle into UCP
Example: Copy update package from network location
Request HeaderPOSThttps://ucpmanagement.ucp.local/api/updatemanagement/firmwareUpdatePackage HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body"\\networklocation\updatePackage.zip"
Response HeaderHTTP/1.1 202 Accepted
Response BodyThe system executes a job named “Copy update package to UCP firmwareupdate repository". The properties for jobs can be viewed in Commonresponse data under UCP Director Resources.
Virtual platform manager resourcesThe table below provides uses for these resources. Additional details foreach use can be found in the sections that follow.
Request Method URIvCenterPrivilege
"List virtual platformmanagers" on the nextpage
GET /api/platform/virtualmanagers UCP View
"Get virtual platformmanager" on page 914
GET/api/platform/virtualmanagers/{VIRTUALMANAGERID}
UCP View
"Modify virtual platformmanager connectioninformation" on page 920
PUT/api/platform/virtualmanagers/{VIRTUALMANAGERID}/connectioninformation
UCP SystemAdministrator
"List vSphere hostprofiles" on page 922
GET/api/platform/virtualmanagers/{VIRTUALMANAGERID}/hostprofiles
UCP View
"Get details for a vSpherehost profile" on page 926
GET/api/platform/virtualmanagers/{VIRTUALMANAGERID}/hostprofiles/{PROFILEID}
UCP View
"List vSphere virtualdistributed switches" onpage 928
GET/api/platform/virtualmanagers/{VIRTUALMANAGERID}/virtualdistributedswitches
UCP View
Chapter 2: UCP Director resources 911UCP Director API Reference
Virtual platformmanager resources
Request Method URIvCenterPrivilege
"Get vSphere virtualdistributed switch" onpage 932
GET
/api/platform/virtualmanagers/{VIRTUALMANAGERID}/virtualdistributedswitches/{SWITCHID}
UCP View
"List virtual machines" onpage 934
GET/api/platform/virtualmanagers/{VIRTUALMANAGERID}/virtualmachines
UCP View
"Get details for a virtualmachine" on page 960
GET
/api/platform/virtualmanagers/{VIRTUALMANAGERID}/virtualmachines/{VIRTUALMACHINEID}
UCP View
"Get user privileges" onpage 962
GET /api/platform/userprivileges UCP View
List virtual platform managers
This HTTP request uses the GET method on the/api/platform/virtualmanagers URI.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
Exactly one virtual platform manager is supported in UCP at this time so theresponse will contain just one object. The properties are detailed under theheading "Get virtual platform manager" on page 914.
Example: List virtual platform managers
In this example, the virtual platform manager is listed. This one is vCenter.
Request HeaderGET https://ucpmanagement.ucp.local/api/platform/virtualmanagersHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[ {
912 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"Id": "1","ResourceType": "VirtualManager","GlobalResourceId": "inst.13371.vmgr.1","InstanceId": "13371","Links": [ { "Rel": "self","Href": "https://ucpmanagement.ucp.local/api/platform/virtualmanagers/1"},{ "Rel": "collection","Href": "https://ucpmanagement.ucp.local/api/platform/virtualmanagers"},{ "Rel": "jobs.self","Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=self"},{ "Rel": "jobs.subcomponent","Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=subcomponent"},{ "Rel": "jobs.all","Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=self%7Csubcomponent"},{ "Rel": "events.self","Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=self"},{ "Rel": "events.subcomponent","Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=subcomponent"},{ "Rel": "events.all","Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=self%7Csubcomponent"},{ "Rel": "webclientconsole","Href": "https://vcenter.ucp.local/vsphere-client"
Chapter 2: UCP Director resources 913UCP Director API Reference
Virtual platformmanager resources
}],"PlatformServer": null,"PlatformType": "VMware","PlatformUrl": "https://vcenter.ucp.local/sdk","PlatformUsername": "ucp\\ucpadmin"}]
Get virtual platform manager
This HTTP request uses the GET method on the/api/platform/virtualmanagers/{VIRTUALMANAGERID} URI, where{VIRTUALMANAGERID} specifies the ID of the virtual platform managerthat is to be returned.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
Virtual platform manager properties are detailed in the following table.
Name Type Notes
(Common properties) See Common properties.
PlatformUrl String
Reports the URL used to access the virtualplatform manager. SCVMM does not have aweb client, hence the value will be null forthis platform.
PlatformType String
The type of platform, whether VMwarevCenter or Microsoft System Center VirtualMachine Manager. Values are - VMware orSCVMM.
PlatformUsername String
Reports the username used to access thevirtual platform manager. This user needsto be an Administrator of the virtualplatform manager.
PlatformServer StringReports the host name or IP address of theplatform server.
Example: Get a virtual platform manager (vCenter)
In this example, the specified platform manager is returned.
914 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
Request HeaderGET https://ucpmanagement.ucp.local/api/platform/virtualmanagers/1HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{ "Id": "1","ResourceType": "VirtualManager","GlobalResourceId": "inst.13371.vmgr.1","InstanceId": "13371","Links": [ { "Rel": "self","Href": "https://ucpmanagement.ucp.local/api/platform/virtualmanagers/1"},{ "Rel": "collection","Href": "https://ucpmanagement.ucp.local/api/platform/virtualmanagers"},{ "Rel": "jobs.self","Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=self"},{ "Rel": "jobs.subcomponent","Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=subcomponent"},{ "Rel": "jobs.all","Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=self%7Csubcomponent"},{ "Rel": "events.self","Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=self"},{ "Rel": "events.subcomponent",
Chapter 2: UCP Director resources 915UCP Director API Reference
Virtual platformmanager resources
"Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=subcomponent"},{ "Rel": "events.all","Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.13371.vmgr.1&relation=self%7Csubcomponent"},{ "Rel": "webclientconsole","Href": "https://vcenter.ucp.local/vsphere-client"}],"PlatformServer": null,"PlatformType": "VMware","PlatformUrl": "https://vcenter.ucp.local/sdk","PlatformUsername": "ucp\\ucpadmin"}}
Example: Get a virtual platform manager (SCVMM)In this example, the specified platform manager is returned.
Request HeaderGET https://ucpmanagement.ucp.local/api/platform/virtualmanagers/1HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "1","ResourceType": "VirtualManager","GlobalResourceId": "inst.UCP-65432.vmgr.1","InstanceId": "UCP-65432","Links": [{"Rel": "self","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/api\/platform\/virtualmanagers\/1"},{"Rel": "collection","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/api\/platform\/virtualmanagers"
916 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
},{"Rel": "jobs.self","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/api\/jobs?targetType=VirtualManager&targetId=inst.UCP-65432.vmgr.1&relation=self"},{"Rel": "jobs.subcomponent","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/api\/jobs?targetType=VirtualManager&targetId=inst.UCP-65432.vmgr.1&relation=subcomponent"},{"Rel": "jobs.all","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/api\/jobs?targetType=VirtualManager&targetId=inst.UCP-65432.vmgr.1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/api\/events?targetType=VirtualManager&targetId=inst.UCP-65432.vmgr.1&relation=self"},{"Rel": "events.subcomponent","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/api\/events?targetType=VirtualManager&targetId=inst.UCP-65432.vmgr.1&relation=subcomponent"},{"Rel": "events.all","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/api\/events?targetType=VirtualManager&targetId=inst.UCP-65432.vmgr.1&relation=self%7Csubcomponent"},{"Rel": "pluginextension","Href": "https:\/\/ucpmanagement_j.ucp.hds.com\/ui\/extension\/get?platform=SCVMM&version=V2012R2&client=UiConsole"}],"PlatformServer": "10.21.152.41","PlatformType": "SCVMM","PlatformUrl": null,"PlatformUsername": "ucp\\svc_ucpj"}
Chapter 2: UCP Director resources 917UCP Director API Reference
Virtual platformmanager resources
Update virtual platform manager
This HTTP request uses the PUT method on the/api/platform/virtualmanagers/{VIRTUALMANAGERID} URI, where{VIRTUALMANAGERID} specifies the ID of the virtual platform managerthat is to be updated.
In vCenter, the UCP System Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
Id String Id of the virtual platform manager.
NetworkEmail StringFor vCenter only. This is the email alias tobe notified when networking-relatedvCenter alarms are triggered.
PlatformPassword StringSpecifies the password that is to be used tomanage the virtual platform manager.
PlatformServer String
Specify this value when using SCVMM. It isthe FQDN or IP address of the SCVMMserver. Do not also supply a value forPlatformUrl.
PlatformUrl String
Specify this value when using vCenter. It isthe web address for accessing the vCenterweb client. Do not also specify a value forPlatformServer.
PlatformUsername StringSpecifies the username and domain that isto be used tomanage the virtual platformmanager.
ServerEmail StringFor vCenter only. This is the email alias tobe notified when server-related vCenteralarms are triggered.
StorageEmail StringFor vCenter only. This is the email alias tobe notified when storage-related vCenteralarms are triggered.
SystemEmail StringFor vCenter only. This is the email alias tobe notified when UCP system-relatedvCenter alarms are triggered.
Response body
918 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
When the request is accepted, a job is started and the body of the responsecontains a job object which can also be requested from Get UCP job. If therequest returns with an error code, the response body will contain adescription of the reason for that error code.
Example: Update SCVMM virtual platform manager
Request HeaderPUT https://ucpmanagement.ucp.local/api/platform/virtualmanagers/1HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"PlatformType": "SCVMM","PlatformPassword":"Kum0@pur@1nS","PlatformServer":"10.21.67.241","PlatformUsername":"ucp\\ucpadmin",}
Response HeaderHTTP/1.1 200 OK
Response BodyThe system executes a job named "Update virtual platform manager".
For common job properties, see the Jobs heading under Introducing UCPDirector API.
Example: Update vCenter virtual platform manager
Request HeaderPUT https://ucpmanagement.ucp.local/api/platform/virtualmanagers/1HTTP/1.1 Content-Type: application/json; charset=utf-8
Request Body{"PlatformType": "VMWare","PlatformPassword":"Kum0@pur@1nS","PlatformUrl":"https://vcenter.ucp.local/sdk","PlatformUsername":"ucp\\ucpadmin","SystemEmail": "[email protected]","StorageEmail": "[email protected]","NetworkEmail": "[email protected]","ServerEmail": "[email protected]"}
Response HeaderHTTP/1.1 200 OK
Response BodyThe system executes a job named "Update virtual platform manager".
Chapter 2: UCP Director resources 919UCP Director API Reference
Virtual platformmanager resources
For common job properties, see the Jobs heading under Introducing UCPDatacenter Director API.
Modify virtual platform manager connection information
This HTTP request uses the PUT method on the/api/platform/virtualmanagers/{VIRTUALMANAGERID}/connectioninformation URI, where {VIRTUALMANAGERID} specifies the IDof the virtual platform manager that is to be updated.
In vCenter, the UCP System Administrator privilege is required.
This request body consists of the properties detailed in the following table.
Name Type Notes
Id String Id of the virtual platform manager.
PlatformServer StringProvide FQDN host name or IP address ofthe SCVMM server. This applies only toSCVMM.
PlatformPassword StringSpecifies the password that is to be used tomanage the virtual platform manager.
PlatformUrl StringSpecifies the URL used to access thevirtual platform manager. This applies onlyto vCenter.
PlatformUsername StringSpecifies the username and domain that isto be used tomanage the virtual platformmanager.
Response body
When the request succeeds, the response body consists of the propertiesdetailed in the following table. No job information is available for this action,but there is one event.
Name Type Notes
(Common properties) String See Common properties
PlatformUrl StringReports the URL used to access the virtualplatform manager. This applies only tovCenter.
920 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
Name Type Notes
PlatformUsername StringUCP uses this username for managing itsconnection to the virtual platformmanager.
PlatformServer String Applicable only for SCVMM.
PlatformType StringThis value is either SCVMM or VMwaredepending on the platform.
Example: Change details of the platform connection information
In this example, the virtual platform manager is vCenter.
Request HeaderPUT https://ucpmanagement.ucp.local/api/platform/virtualmanagers/1/connectioninformation HTTP/1.1Content-Type: application/json; charset=utf-8
Request Body{"PlatformPassword":"Kum0@pur@1nS","PlatformUrl":"https:\/\/vcenter.ucp.local\/sdk ","PlatformUsername":"[email protected]",}
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "1","ResourceType": "VirtualManager","GlobalResourceId": "inst.UCP-13372.vmgr.1","InstanceId": "UCP-13372","Links": [ { "Rel": "self","Href": "https://ucpmanagement.ucp.local/api/platform/virtualmanagers/1"},{ "Rel": "collection","Href": "https://ucpmanagement.ucp.local/api/platform/virtualmanagers"},{ "Rel": "jobs.self","Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.UCP-13372.vmgr.1&relation=self"},{ "Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 921UCP Director API Reference
Virtual platformmanager resources
"Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.UCP-13372.vmgr.1&relation=subcomponent"},{ "Rel": "jobs.all","Href":"https://ucpmanagement.ucp.local/api/jobs?targetType=VirtualManager&targetId=inst.UCP-13372.vmgr.1&relation=self%7Csubcomponent"},{ "Rel": "events.self","Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.UCP-13372.vmgr.1&relation=self"},{ "Rel": "events.subcomponent","Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.UCP-13372.vmgr.1&relation=subcomponent"},{ "Rel": "events.all","Href":"https://ucpmanagement.ucp.local/api/events?targetType=VirtualManager&targetId=inst.UCP-13372.vmgr.1&relation=self%7Csubcomponent"},{ "Rel": "webclientconsole","Href": "https://vcenter.ucp.local/vsphere-client"}],"PlatformServer": "vcenter.ucp.local","PlatformType": "VMware","PlatformUrl": "https://vcenter.ucp.local/sdk","PlatformUsername": "ucp\\svc_ucp"}
List vSphere host profiles
This HTTP request uses the GET method on the/api/platform/virtualmanagers/{VIRTUALMANAGERID}/hostprofiles API.
When compute hosts are running stateless ESXi, their configuration detailsmust be reapplied after every reboot. Host profiles are a collection ofconfiguration details for compute hosts. UCP creates a new host profile for
922 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
each cluster which is made by a UCP template. The process of creating acluster by UCP template requires a sample host profile which will be copiedand edited by UCP for the new cluster.
When making a UCP service template for ESXi clusters, a host profile Id isrequired in the request body.
Host profiles can be listed and viewed by UCP API, but cannot be created oredited through UCP API.
In vCenter, the UCP View privilege is required.
Request body
The body for this request must be empty.
Response body
The response body contains the following properties.
Name Type Notes
Name String The display name of the host profile.
VirtualManagerId StringThe virtual platform Id from where hostprofiles are retrieved.
Example: List host profiles in vCenter
This example lists host profiles.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/platform/virtualmanagers/1/hostprofiles HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "hostprofile-1","ResourceType": "HostProfile","GlobalResourceId": "inst.UCP-12345.vmgr.1.hprof.hostprofile-1","InstanceId": "UCP-12345",
Chapter 2: UCP Director resources 923UCP Director API Reference
Virtual platformmanager resources
"Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/hostprofiles\/hostprofile-1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/hostprofiles"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=self%7Csubcomponent"}
924 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
],"Name": "ProfileForCluster","VirtualManagerId": "1"},{"Id": "hostprofile-3","ResourceType": "HostProfile","GlobalResourceId": "inst.UCP-12345.vmgr.1.hprof.hostprofile-3","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/hostprofiles\/hostprofile-3"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/hostprofiles"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-3&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-3&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-3&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-3&relation=self"},{"Rel": "events.subcomponent",
Chapter 2: UCP Director resources 925UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-3&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-3&relation=self%7Csubcomponent"}],"Name": "ClusterTest-73-HostProfile","VirtualManagerId": "1"}}
Get details for a vSphere host profile
This HTTP request uses the GET method on theapi/platform/virtualmanagers/{VIRTUALMANAGERID}/hostprofiles/{PROFILEID} API
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
When the request succeeds, the response body contains the commonresponse data as well as the properties shown in the following table.
Name Type Notes
Id String The id of the host profile
Name String Name of the host profile
Example: Get host profile by name
This example returns details for the specified host profile.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/platform/virtualmanagers/1/hostprofiles/hostprofile-1HTTP/1.1Content-Type: application/json; charset=utf-8
926 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "hostprofile-1","ResourceType": "HostProfile","GlobalResourceId": "inst.UCP-12345.vmgr.1.hprof.hostprofile-1","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/hostprofiles\/hostprofile-1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/hostprofiles"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=self"},{"Rel": "events.subcomponent",
Chapter 2: UCP Director resources 927UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=HostProfile&targetId=inst.UCP-12345.vmgr.1.hprof.hostprofile-1&relation=self%7Csubcomponent"}],"Name": "ProfileForCluster","VirtualManagerId": "1"}
List vSphere virtual distributed switches
This HTTP request uses the GET method on theapi/platform/virtualmanagers/{VIRTUALMANAGERID}/virtualdistributedswitches API.
This API is applicable only in vCenter platforms.
vSphere distributed switches are used when a UCP template creates anESXi cluster. The payload for creating a cluster template may include the idof a virtual distributed switch. If not, it should specify the necessary detailsto create a virtual distributed switch for the cluster. Multiple clusters mayshare the same virtual distributed switch. UCP cluster templates expect thevirtual distributed switch to have at least the following port groups:Management, Compute, vMotion.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
Response body
When the request succeeds, the response body contains the commonresponse data as well as the properties shown in the following table.
This API returns the following data for all virtual distributed switches fromthe specified vSphere platform Id.
928 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
Name Type Notes
Name String Name of the virtual distributed switch
PortGroupNames String Array containing all port group names
VirtualManagerId StringThe virtual platform Id from where hostprofiles are retrieved.
Example: List virtual distributed switches in the virtual platform
This example lists the virtual distributed switches in vCenter.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/platform/virtualmanagers/1/virtualdistributedswitchesHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "dvs-117","ResourceType": "VirtualSwitch","GlobalResourceId": "inst.UCP-12345.vmgr.1.vswitch.dvs-117","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualdistributedswitches\/dvs-117"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualdistributedswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=self"},{
Chapter 2: UCP Director resources 929UCP Director API Reference
Virtual platformmanager resources
"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=self%7Csubcomponent"}],"Name": "dvSampleSwitch","PortGroupNames": ["dvSampleManagementPGroup","dvSampleVMOTIONPGrp","dvPortGroup","dvSampleComputePGrp"],"VirtualManagerId": "1"},{"Id": "dvs-75","ResourceType": "VirtualSwitch","GlobalResourceId": "inst.UCP-12345.vmgr.1.vswitch.dvs-75","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualdistributedswitches\/dvs-75"
930 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualdistributedswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-75&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-75&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-75&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-75&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-75&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-75&relation=self%7Csubcomponent"}],"Name": "dvSwitch-ClusterTest-73","PortGroupNames": ["TestPortGroup","dvpg-ClusterTest-73-Compute-VLAN125","dvpg-ClusterTest-73-VMotion","dvpg-ClusterTest-73-Management"
Chapter 2: UCP Director resources 931UCP Director API Reference
Virtual platformmanager resources
],"VirtualManagerId": "1"}
Get vSphere virtual distributed switch
This HTTP request uses the GET method on the/api/platform/virtualmanagers/{VIRTUALMANAGERID}/virtualdistributedswitches/{VIRTUALDISTRIBUTEDSWITCHID} API.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
This API returns the following data for the specified virtual distributedswitch.
Name Type Notes
Name String Name of the virtual distributed switch
PortGroupNames String Array containing all port group names
VirtualManagerId StringThe virtual platform Id from where hostprofiles are retrieved.
Example: Get a virtual distributed switch by Id
This example returns the specified virtual distributed switch.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/platform/virtualmanagers/1/virtualdistributedswitches/dvs-117HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "dvs-117","ResourceType": "VirtualSwitch","GlobalResourceId": "inst.UCP-12345.vmgr.1.vswitch.dvs-117","InstanceId": "UCP-12345","Links": [
932 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualdistributedswitches\/dvs-117"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualdistributedswitches"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualSwitch&targetId=inst.UCP-12345.vmgr.1.vswitch.dvs-117&relation=self%7Csubcomponent"}],"Name": "dvSampleSwitch",
Chapter 2: UCP Director resources 933UCP Director API Reference
Virtual platformmanager resources
"PortGroupNames": ["dvSampleManagementPGroup","dvSampleVMOTIONPGrp","dvPortGroup","dvSampleComputePGrp"],"VirtualManagerId": "1"}
List virtual machines
This HTTP request uses the GET method on the/api/platform/virtualmanagers/{VIRTUALMANAGERID}/virtualmachinesAPI.
This API is applicable when the platform manager is vCenter.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
All virtual machines in the platform are returned, including those in the UCPmanagement stack. Properties of virtual machines are detailed under thesubheading Get details for a virtual machine.
Example: List virtual machines in the platform
In this example, all VMs are listed, including those in the UCP managementstack.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/platform/virtualmanagers/1/virtualmachinesHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body[{"Id": "422a8893-14af-d02d-193f-029878f3e22c","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c",
934 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/422a8893-14af-d02d-193f-029878f3e22c"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=subcomponent"},{"Rel": "events.all",
Chapter 2: UCP Director resources 935UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=self%7Csubcomponent"}],"ContextId": "vm-125","Name": "Test","VirtualManagerId": "1","VirtualNics": [{"Id": "5efc472f-06c1-11e2-a75f-9dd657453cae-4000","MacAddress": "00:50:56:aa:06:0c","VirtualSwitchId": "5efc472f-06c1-11e2-a75f-9dd657453cae-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-VM Network"}]},{"Id": "422a1946-c9c6-a70e-9553-4555bf78657c","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.422a1946-c9c6-a70e-9553-4555bf78657c","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/422a1946-c9c6-a70e-9553-4555bf78657c"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a1946-c9c6-a70e-9553-4555bf78657c&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a1946-c9c6-a70e-9553-4555bf78657c&relation=subcomponent"
936 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a1946-c9c6-a70e-9553-4555bf78657c&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a1946-c9c6-a70e-9553-4555bf78657c&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a1946-c9c6-a70e-9553-4555bf78657c&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a1946-c9c6-a70e-9553-4555bf78657c&relation=self%7Csubcomponent"}],"ContextId": "vm-126","Name": "Dev","VirtualManagerId": "1","VirtualNics": [{"Id": "5efc472f-06c1-11e2-a75f-9dd657453cae-4000","MacAddress": "00:50:56:aa:58:a9","VirtualSwitchId": "5efc472f-06c1-11e2-a75f-9dd657453cae-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-VM Network"}]},{"Id": "422a398a-566a-42db-ebc2-52c5ad04eca1","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.422a398a-566a-42db-ebc2-52c5ad04eca1","InstanceId": "UCP-12345","Links": [{
Chapter 2: UCP Director resources 937UCP Director API Reference
Virtual platformmanager resources
"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/422a398a-566a-42db-ebc2-52c5ad04eca1"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a398a-566a-42db-ebc2-52c5ad04eca1&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a398a-566a-42db-ebc2-52c5ad04eca1&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a398a-566a-42db-ebc2-52c5ad04eca1&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a398a-566a-42db-ebc2-52c5ad04eca1&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a398a-566a-42db-ebc2-52c5ad04eca1&relation=subcomponent"},{"Rel": "events.all",
938 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a398a-566a-42db-ebc2-52c5ad04eca1&relation=self%7Csubcomponent"}],"ContextId": "vm-89","Name": "v3.0.2ServiceVM","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "00:50:56:aa:24:c0","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"},{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4001","MacAddress": "00:50:56:aa:64:36","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch1","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-50331668","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-Management VMNetwork"},{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4002","MacAddress": "00:50:56:aa:5e:1d","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch1","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-50331668","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-Management VMNetwork"}]},{"Id": "564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54"},
Chapter 2: UCP Director resources 939UCP Director API Reference
Virtual platformmanager resources
{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d10e0-dfbc-cc6e-2a3c-e9fdbbfd4f54&relation=self%7Csubcomponent"}],"ContextId": "vm-27","Name": "UCPUtility","VirtualManagerId": "1",
940 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "d0:5f:ce:99:00:06","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"},{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4001","MacAddress": "d0:5f:ce:99:00:07","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch1","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-50331668","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-Management VMNetwork"}]},{"Id": "564d532e-2e7a-13cd-6ad9-b4677be514c6","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564d532e-2e7a-13cd-6ad9-b4677be514c6","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564d532e-2e7a-13cd-6ad9-b4677be514c6"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d532e-2e7a-13cd-6ad9-b4677be514c6&relation=self"},{"Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 941UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d532e-2e7a-13cd-6ad9-b4677be514c6&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d532e-2e7a-13cd-6ad9-b4677be514c6&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d532e-2e7a-13cd-6ad9-b4677be514c6&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d532e-2e7a-13cd-6ad9-b4677be514c6&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d532e-2e7a-13cd-6ad9-b4677be514c6&relation=self%7Csubcomponent"}],"ContextId": "vm-25","Name": "HTnM","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "00:0c:29:e5:14:c6","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"}]},{"Id": "564dcea4-398a-f4a5-5964-57f090cf7f93","ResourceType": "VirtualMachine",
942 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564dcea4-398a-f4a5-5964-57f090cf7f93","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564dcea4-398a-f4a5-5964-57f090cf7f93"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dcea4-398a-f4a5-5964-57f090cf7f93&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dcea4-398a-f4a5-5964-57f090cf7f93&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dcea4-398a-f4a5-5964-57f090cf7f93&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dcea4-398a-f4a5-5964-57f090cf7f93&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dcea4-398a-f4a5-5964-57f090cf7f93&relation=subcomponent"},{
Chapter 2: UCP Director resources 943UCP Director API Reference
Virtual platformmanager resources
"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dcea4-398a-f4a5-5964-57f090cf7f93&relation=self%7Csubcomponent"}],"ContextId": "vm-26","Name": "SQL","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "00:0c:29:cf:7f:93","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"}]},{"Id": "564d86ca-ef20-171a-80ee-300bb9009415","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564d86ca-ef20-171a-80ee-300bb9009415","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564d86ca-ef20-171a-80ee-300bb9009415"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d86ca-ef20-171a-80ee-300bb9009415&relation=self"},{"Rel": "jobs.subcomponent",
944 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d86ca-ef20-171a-80ee-300bb9009415&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d86ca-ef20-171a-80ee-300bb9009415&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d86ca-ef20-171a-80ee-300bb9009415&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d86ca-ef20-171a-80ee-300bb9009415&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d86ca-ef20-171a-80ee-300bb9009415&relation=self%7Csubcomponent"}],"ContextId": "vm-43","Name": "WSUS","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "00:50:56:aa:14:04","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"}]},{"Id": "564dccac-5c7b-b1e8-a196-7cb9d1124400","ResourceType": "VirtualMachine",
Chapter 2: UCP Director resources 945UCP Director API Reference
Virtual platformmanager resources
"GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564dccac-5c7b-b1e8-a196-7cb9d1124400","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564dccac-5c7b-b1e8-a196-7cb9d1124400"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dccac-5c7b-b1e8-a196-7cb9d1124400&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dccac-5c7b-b1e8-a196-7cb9d1124400&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dccac-5c7b-b1e8-a196-7cb9d1124400&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dccac-5c7b-b1e8-a196-7cb9d1124400&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dccac-5c7b-b1e8-a196-7cb9d1124400&relation=subcomponent"},{
946 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dccac-5c7b-b1e8-a196-7cb9d1124400&relation=self%7Csubcomponent"}],"ContextId": "vm-41","Name": "WDS","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "d0:5f:ce:99:00:10","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"},{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4001","MacAddress": "d0:5f:ce:99:00:11","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch1","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-50331668","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-Management VMNetwork"}]},{"Id": "564d8856-860d-9062-9c0e-5490b8a22875","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564d8856-860d-9062-9c0e-5490b8a22875","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564d8856-860d-9062-9c0e-5490b8a22875"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self",
Chapter 2: UCP Director resources 947UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d8856-860d-9062-9c0e-5490b8a22875&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d8856-860d-9062-9c0e-5490b8a22875&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d8856-860d-9062-9c0e-5490b8a22875&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d8856-860d-9062-9c0e-5490b8a22875&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d8856-860d-9062-9c0e-5490b8a22875&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d8856-860d-9062-9c0e-5490b8a22875&relation=self%7Csubcomponent"}],"ContextId": "vm-21","Name": "UCPAutomation","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "00:50:56:94:55:42","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463",
948 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"}]},{"Id": "564deacb-25b2-d2cd-7463-2d28da18c5f4","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564deacb-25b2-d2cd-7463-2d28da18c5f4","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564deacb-25b2-d2cd-7463-2d28da18c5f4"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564deacb-25b2-d2cd-7463-2d28da18c5f4&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564deacb-25b2-d2cd-7463-2d28da18c5f4&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564deacb-25b2-d2cd-7463-2d28da18c5f4&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564deacb-25b2-d2cd-7463-2d28da18c5f4&relation=self"},
Chapter 2: UCP Director resources 949UCP Director API Reference
Virtual platformmanager resources
{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564deacb-25b2-d2cd-7463-2d28da18c5f4&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564deacb-25b2-d2cd-7463-2d28da18c5f4&relation=self%7Csubcomponent"}],"ContextId": "vm-23","Name": "AD1","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "d0:5f:ce:99:00:01","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"}]},{"Id": "564d1cb3-55f0-7655-8d46-7e293d5c2408","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564d1cb3-55f0-7655-8d46-7e293d5c2408","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564d1cb3-55f0-7655-8d46-7e293d5c2408"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self",
950 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d1cb3-55f0-7655-8d46-7e293d5c2408&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d1cb3-55f0-7655-8d46-7e293d5c2408&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d1cb3-55f0-7655-8d46-7e293d5c2408&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d1cb3-55f0-7655-8d46-7e293d5c2408&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d1cb3-55f0-7655-8d46-7e293d5c2408&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d1cb3-55f0-7655-8d46-7e293d5c2408&relation=self%7Csubcomponent"}],"ContextId": "vm-24","Name": "HCS","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "d0:5f:ce:99:00:02","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463",
Chapter 2: UCP Director resources 951UCP Director API Reference
Virtual platformmanager resources
"VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"}]},{"Id": "564d83d3-42af-a9f5-bfb8-369544fa93fd","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564d83d3-42af-a9f5-bfb8-369544fa93fd","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564d83d3-42af-a9f5-bfb8-369544fa93fd"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d83d3-42af-a9f5-bfb8-369544fa93fd&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d83d3-42af-a9f5-bfb8-369544fa93fd&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d83d3-42af-a9f5-bfb8-369544fa93fd&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d83d3-42af-a9f5-bfb8-369544fa93fd&relation=self"},
952 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d83d3-42af-a9f5-bfb8-369544fa93fd&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d83d3-42af-a9f5-bfb8-369544fa93fd&relation=self%7Csubcomponent"}],"ContextId": "vm-22","Name": "v3.0ServiceVM (1)","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "00:0c:29:fa:93:fd","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"},{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4001","MacAddress": "00:0c:29:fa:93:07","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch1","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-50331668","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-Management VMNetwork"},{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4002","MacAddress": "00:0c:29:fa:93:11","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch1","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-50331668","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-Management VMNetwork"}]},{"Id": "564da30c-036b-9512-6144-79ffe96fbaff","ResourceType": "VirtualMachine",
Chapter 2: UCP Director resources 953UCP Director API Reference
Virtual platformmanager resources
"GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564da30c-036b-9512-6144-79ffe96fbaff","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564da30c-036b-9512-6144-79ffe96fbaff"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da30c-036b-9512-6144-79ffe96fbaff&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da30c-036b-9512-6144-79ffe96fbaff&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da30c-036b-9512-6144-79ffe96fbaff&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da30c-036b-9512-6144-79ffe96fbaff&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da30c-036b-9512-6144-79ffe96fbaff&relation=subcomponent"},{
954 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da30c-036b-9512-6144-79ffe96fbaff&relation=self%7Csubcomponent"}],"ContextId": "vm-44","Name": "SRM","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "00:50:56:aa:72:ba","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"}]},{"Id": "564dd66b-8dee-810d-91a6-764d4af7637d","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564dd66b-8dee-810d-91a6-764d4af7637d","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564dd66b-8dee-810d-91a6-764d4af7637d"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dd66b-8dee-810d-91a6-764d4af7637d&relation=self"},{"Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 955UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dd66b-8dee-810d-91a6-764d4af7637d&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dd66b-8dee-810d-91a6-764d4af7637d&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dd66b-8dee-810d-91a6-764d4af7637d&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dd66b-8dee-810d-91a6-764d4af7637d&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564dd66b-8dee-810d-91a6-764d4af7637d&relation=self%7Csubcomponent"}],"ContextId": "vm-28","Name": "vCenter","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "d0:5f:ce:99:00:08","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"},{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4001","MacAddress": "d0:5f:ce:99:00:09","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch1",
956 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"VirtualSwitchPortId": "key-vim.host.PortGroup.Port-50331668","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-Management VMNetwork"}]},{"Id": "564da1a7-f1e4-6f0e-1692-dcc9bb6103a0","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564da1a7-f1e4-6f0e-1692-dcc9bb6103a0","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564da1a7-f1e4-6f0e-1692-dcc9bb6103a0"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da1a7-f1e4-6f0e-1692-dcc9bb6103a0&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da1a7-f1e4-6f0e-1692-dcc9bb6103a0&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da1a7-f1e4-6f0e-1692-dcc9bb6103a0&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da1a7-f1e4-6f0e-1692-dcc9bb6103a0&relation=self"
Chapter 2: UCP Director resources 957UCP Director API Reference
Virtual platformmanager resources
},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da1a7-f1e4-6f0e-1692-dcc9bb6103a0&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564da1a7-f1e4-6f0e-1692-dcc9bb6103a0&relation=self%7Csubcomponent"}],"ContextId": "vm-45","Name": "UCPDatacenter","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "00:50:56:aa:4a:76","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"}]},{"Id": "564d3d7c-8958-7d4e-ec56-146f2505d321","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.564d3d7c-8958-7d4e-ec56-146f2505d321","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/564d3d7c-8958-7d4e-ec56-146f2505d321"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self",
958 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d3d7c-8958-7d4e-ec56-146f2505d321&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d3d7c-8958-7d4e-ec56-146f2505d321&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d3d7c-8958-7d4e-ec56-146f2505d321&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d3d7c-8958-7d4e-ec56-146f2505d321&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d3d7c-8958-7d4e-ec56-146f2505d321&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.564d3d7c-8958-7d4e-ec56-146f2505d321&relation=self%7Csubcomponent"}],"ContextId": "vm-42","Name": "UCPManagement","VirtualManagerId": "1","VirtualNics": [{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4000","MacAddress": "d0:5f:ce:99:00:04","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-33554463",
Chapter 2: UCP Director resources 959UCP Director API Reference
Virtual platformmanager resources
"VirtualSwitchPortProfileId": "key-vim.host.PortGroup-ElementManagement"},{"Id": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-4001","MacAddress": "d0:5f:ce:99:00:05","VirtualSwitchId": "ffffffff-ffff-ffff-ffff-d43d7e0885f4-key-vim.host.VirtualSwitch-vSwitch1","VirtualSwitchPortId": "key-vim.host.PortGroup.Port-50331668","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-Management VMNetwork"}]}}
Get details for a virtual machine
This HTTP request uses the GET method on the/api/platform/virtualmanagers/{VIRTUALMANAGERID}/virtualmachines/{VIRTUALMACHINEID} API.
This API is applicable only in vCenter platforms.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
VMware virtual machines have the following properties.
Name Type Notes
ContextId String An Id specific to the platform manager.
Name String Display name of the virtual machine.
VirtualNics CollectionCollection of the followingmetadataregarding the virtual NICs in this VM.
Id StringId of the virtual machine NIC. This ID is inthe form of a GUID.
MacAddress String MAC address of the virtual machine NIC.
VirtualSwitchId StringVirtual switch used by the virtualmachine.
VirtualSwitchPortId StringVirtual switch port used by the virtualmachine.
VirtualSwitchPortProfileId StringVirtual switch port profile used by thevirtual machine.
960 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
Example: Get a virtual machine in the virtual platform manager
In this example, the specified virtual machine is returned. The platformmanager is vCenter.
Request HeaderGEThttps://ucpmanagement.ucp.local/api/platform/virtualmanagers/1/virtualmachines/422a8893-14af-d02d-193f-029878f3e22cHTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "422a8893-14af-d02d-193f-029878f3e22c","ResourceType": "VirtualMachine","GlobalResourceId": "inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines\/422a8893-14af-d02d-193f-029878f3e22c"},{"Rel": "collection","Href":"https:\/\/ucpmanagement.ucp.local\/api\/platform\/virtualmanagers\/1\/virtualmachines"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=self"},{"Rel": "jobs.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=subcomponent"
Chapter 2: UCP Director resources 961UCP Director API Reference
Virtual platformmanager resources
},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/jobs?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.ucp.local\/api\/events?targetType=VirtualMachine&targetId=inst.UCP-12345.vmgr.1.vm.422a8893-14af-d02d-193f-029878f3e22c&relation=self%7Csubcomponent"}],"ContextId": "vm-125","Name": "Test","VirtualManagerId": "1","VirtualNics": [{"Id": "5efc472f-06c1-11e2-a75f-9dd657453cae-4000","MacAddress": "00:50:56:aa:06:0c","VirtualSwitchId": "5efc472f-06c1-11e2-a75f-9dd657453cae-key-vim.host.VirtualSwitch-vSwitch0","VirtualSwitchPortId": "","VirtualSwitchPortProfileId": "key-vim.host.PortGroup-VM Network"}]}
Get user privileges
This HTTP request uses the GET method on the /api/platform/userprivilegesURI.
962 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
The list of permissions is the same regardless of the virtual platformmanager type. However, in SCVMM, there is only the Administrator role,which has all UCP privileges.
In vCenter, the UCP View privilege is required.
The body for this request must be empty.
User privileges have the following properties.
Name Type Notes
PermissionsArray ofStrings
The list of UCP user privileges is returned.
Example: Get user privileges
This example lists the UCP privileges.
Request HeaderGET https://ucpmanagement.ucp.local/api/platform/userprivileges HTTP/1.1Content-Type: application/json; charset=utf-8
Request BodyThe body for this request must be empty.
Response HeaderHTTP/1.1 200 OK
Response Body{"Id": "0","ResourceType": "UserPermissionList","GlobalResourceId": "inst.UCP-12345.vmgr.0.prvlg","InstanceId": "UCP-12345","Links": [{"Rel": "self","Href":"https:\/\/ucpmanagement.poda.local\/api\/platform\/userprivileges"},{"Rel": "jobs.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=UserPermissionList&targetId=inst.UCP-12345.vmgr.0.prvlg&relation=self"},{"Rel": "jobs.subcomponent",
Chapter 2: UCP Director resources 963UCP Director API Reference
Virtual platformmanager resources
"Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=UserPermissionList&targetId=inst.UCP-12345.vmgr.0.prvlg&relation=subcomponent"},{"Rel": "jobs.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/jobs?targetType=UserPermissionList&targetId=inst.UCP-12345.vmgr.0.prvlg&relation=self%7Csubcomponent"},{"Rel": "events.self","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=UserPermissionList&targetId=inst.UCP-12345.vmgr.0.prvlg&relation=self"},{"Rel": "events.subcomponent","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=UserPermissionList&targetId=inst.UCP-12345.vmgr.0.prvlg&relation=subcomponent"},{"Rel": "events.all","Href":"https:\/\/ucpmanagement.poda.local\/api\/events?targetType=UserPermissionList&targetId=inst.UCP-12345.vmgr.0.prvlg&relation=self%7Csubcomponent"}],"Permissions": ["UCP.NetworkAdministration","UCP.NetworkConsole","UCP.ServerAdministration","UCP.ServerConsole","UCP.Service","UCP.StorageAdministration","UCP.StorageConsole","UCP.SystemAdministration","UCP.View"]}
964 Chapter 2: UCP Director resources
UCP Director API Reference
Virtual platformmanager resources
UCP Director API Reference
MK-92UCP046-07
Hitachi Data Systems
Corporate Headquarters2845 Lafayette StreetSanta Clara, California 95050-2627U.S.A.www.hds.com
Regional Contact Information
Americas+1 408 970 [email protected]
Europe, Middle East, and Africa+44 (0) 1753 [email protected]
Asia Pacific+852 3189 [email protected]