7.2
Table Of Contents
- Programming Guide
- Contents
- vRealize Automation Programming Guide
- Overview of the vRealize Automation REST API
- REST API Authentication
- REST API Use Cases
- Create a Tenant
- Syntax for Displaying Your Current Tenants
- Syntax for Requesting a New Tenant
- Syntax for Listing All Tenant Identity Stores
- Syntax for Linking an Identity Store to the Tenant
- Syntax for Searching LDAP or Active Directory for a User
- Syntax for Assigning a User to a Role
- Syntax for Displaying all Roles Assigned to a User
- Request a Machine
- Approve a Machine Request
- List Provisioned Resources
- Manage Provisioned Deployments
- Working with Reservations
- Create a Reservation
- Display a List of Supported Reservation Types
- Displaying a Schema Definition for a Reservation
- Get the Business Group ID for a Reservation
- Get a Compute Resource for the Reservation
- Getting a Resources Schema by Reservation Type
- Creating a Reservation By Type
- Verify a Reservation and Get Reservation Details
- Display a List of Reservations
- Update a Reservation
- Delete a Reservation
- Create a Reservation
- Working with Reservation Policies
- Working with Key Pairs
- Working with Network Profiles
- Get a List of Available IP Ranges for an IPAM Provider
- Import and Export Content
- Syntax for Listing Supported Content Types
- Syntax for Listing Available Content
- Syntax for Filtering Content by Content Type
- Syntax for Creating a Package for Export
- Syntax for Listing Packages in the Content Service
- Syntax for Exporting a Package
- Syntax for Validating a Content Bundle Before Importing
- Syntax for Importing a Package
- Understanding Blueprint Schema
- Manage XaaS Content with Import and Export
- Create a Tenant
- Related Tools and Documentation
- Filtering and Formatting REST API Information
- Index
+bXZzwgFQ2JE4SYxojNHPYwBjadFm0A2eVPtOivMYYYr8FCUYtfbjjIS1TyJaKIFhhqs6bA6/PH
+NvBmbozpDkH9wg3mQ1SOP5iSMAMue6fx+b/SpOZ5MPnNjRo
+VXG3qFl936AB4F1F2ObD27GyjibeYmhQkITtp/yGYCZ68PhCun0/eiEjmXiOUx/5jYGOUEZ1Ddojhc5M/PClR46vQ/3I
yv5pUGPno
+wkn34lk6s2PO2axrXvQqTwoiYC3f2p1gp0qYidIzKa2KHrUCOF4hnjQ3v3z93ORMCK3wN5uQ3xMFOd7+1XpetxvG9d7L
1lU/sgCVmEhdOSnhLC5Jeq70MVwixPocnJR4nyotPE=="
}
“
Syntax for Creating a Key Pair
You can use the vRealize Automation REST API to create a key pair.
Input
Use the supported input parameters to control the command output.
Input Description
URL hps://$host/iaas-proxy-provider/api/keyPairs
Method Post
$host Species the host name and fully qualied domain name or
IP address of the vRealize Automation identity server.
$token Species a valid HTTP bearer token with necessary
credentials.
HTTP Body Contains the HTTP body of the target key pair.
n
$id:
Species the unique identier of the key pair.
n
$name:
Species the name of the key pair.
n
$computeResourceId:
Species the compute resource ID that is binded to the
key pair.
n
$secretKey:
Species the secret key for the key pair.
Output
The command output contains property names and values based on the command input parameters.
Parameter Description
status
If the command is successful, the HTTP status is 201
Created.
Header.Location
The hp response should contain a Location aribute that
is formaed as https://$host/iaas-proxy-
provider/api/keyPairs/$keypairID.
$keypairID Species the unique identier of the new key pair.
Example: curl Command
curl --insecure -H "Accept:application/json"
-H "Authorization: Bearer $token"
https://$host/iaas-proxy-provider/api/keyPairs -d
“
Programming Guide
280 VMware, Inc.