VRA CATALOG Commands


DescriptionCommand
CatalogItem Details     vra catalog detail
List CatalogItems optionally filtered by type.     vra catalog list
Generate a catalog request template in the form of a JSON file     vra catalog request generate template
Make a new Request from a given CatalogItem     vra catalog request submit


CatalogItem Details

vra catalog detail

Parameter--id (Provide a valid catalog item ID or name.)
Mandatorytrue

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse


List CatalogItems optionally filtered by type.

vra catalog list

Parameter--businessGroupId (Provide a valid business group ID or name.)
Mandatoryfalse

Parameter--type (Type of CatalogItem to display [COMPOSITE_BLUEPRINT, XAAS or ALL]. If option is not provided displays all CatalogItems)
Mandatoryfalse

Parameter--page (Enter page number to display in pagination (default 1))
Mandatoryfalse

Parameter--pageSize (Enter page size to display in pagination (default 25, maximum 5000))
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse


Generate a catalog request template in the form of a JSON file

vra catalog request generate template

Parameter--groupid (Provide a valid business group ID or name.)
Mandatorytrue

Parameter--id (Provide a valid catalog item ID or name.)
Mandatorytrue

Parameter--reason (Enter a reason for this request)
Mandatorytrue

Parameter--description (Enter a Description)
Mandatoryfalse

Parameter--requestedFor (Enter the user for whom the machine will be provisioned.)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatorytrue


Make a new Request from a given CatalogItem

vra catalog request submit

Parameter--groupid (Provide a valid business group ID or name.)
Mandatoryfalse

Parameter--id (Provide a valid catalog item ID or name.)
Mandatoryfalse

Parameter--cpu (Enter the number of Cpu's)
Mandatoryfalse

Parameter--memory (Enter the amount of memory in MB)
Mandatoryfalse

Parameter--leasedays (Enter a positive numeric value for lease days. If unspecified or specified 0, default value for leasedays from Blueprint will be used)
Mandatoryfalse

Parameter--reason (Enter a reason for this request)
Mandatoryfalse

Parameter--description (Enter a Description)
Mandatoryfalse

Parameter--properties (Enter comma separated list of properties. To escape special characters, enclose them in single quotes. Eg: "foo.bar='foo bar,bar:55'")
Mandatoryfalse

Parameter--requestedFor (Enter the user for whom the machine will be provisioned.)
Mandatoryfalse

Parameter--inputfile (The catalog request template to use. WARNING: This will override all other parameters.)
Mandatoryfalse


Copyright 2019 VMware, Inc. All rights reserved.