New-vRAPropertyDefinition
SYNOPSIS
Create a custom Property Definition
SYNTAX
String
New-vRAPropertyDefinition -Name <String> [-Label <String>] [-Description <String>] [-Tenant <String>]
[-Index <Int32>] [-Required] [-Encrypted] [-String] -StringDisplay <String> [-WhatIf] [-Confirm]
Boolean
New-vRAPropertyDefinition -Name <String> [-Label <String>] [-Description <String>] [-Tenant <String>]
[-Index <Int32>] [-Required] [-Encrypted] [-Boolean] -BooleanDisplay <String> [-WhatIf] [-Confirm]
Integer
New-vRAPropertyDefinition -Name <String> [-Label <String>] [-Description <String>] [-Tenant <String>]
[-Index <Int32>] [-Required] [-Encrypted] [-Integer] -IntegerDisplay <String> [-WhatIf] [-Confirm]
Decimal
New-vRAPropertyDefinition -Name <String> [-Label <String>] [-Description <String>] [-Tenant <String>]
[-Index <Int32>] [-Required] [-Encrypted] [-Decimal] -DecimalDisplay <String> [-WhatIf] [-Confirm]
Datetime
New-vRAPropertyDefinition -Name <String> [-Label <String>] [-Description <String>] [-Tenant <String>]
[-Index <Int32>] [-Required] [-Encrypted] [-Datetime] -DatetimeDisplay <String> [-WhatIf] [-Confirm]
JSON
New-vRAPropertyDefinition -Name <String> [-Label <String>] [-Description <String>] [-Tenant <String>]
[-Index <Int32>] [-Required] [-Encrypted] -JSON <String> [-WhatIf] [-Confirm]
DESCRIPTION
Create a custom Property Definition
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
# Create a string dropdown with defined values
New-vRAPropertyDefinition -Name one -String -StringDisplay DROPDOWN -ValueType Static -Values @{Name1="Value1";Name2="Value2"}
-------------------------- EXAMPLE 2 --------------------------
# Create an integer slider with min, max and increment
New-vRAPropertyDefinition -Name IntegerName -Label "Select an Integer" -Integer -IntegerDisplay SLIDER -MinimumValue 1 -MaximumValue 10 -Increment 1
-------------------------- EXAMPLE 3 --------------------------
# Create a boolean checkbox
New-vRAPropertyDefinition -Name BooleanName -Label "Check this box" -Boolean -BooleanDisplay CHECKBOX
-------------------------- EXAMPLE 4 --------------------------
# Create a new decimal slider with min, max and increment
New-vRAPropertyDefinition -Name DecimalTest -Decimal -DecimalDisplay SLIDER -MinimumValue 0 -MaximumValue 10 -Increment 0.5
PARAMETERS
-Name
The unique name (ID) of the Property
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Label
The text to display in forms for the Property
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $Name
Accept pipeline input: False
Accept wildcard characters: False
-Description
Description of the Property
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tenant
The tenant in which to create the Property Definition (Defaults to the connection tenant )
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $Global:vRAConnection.Tenant
Accept pipeline input: False
Accept wildcard characters: False
-Index
The display index of the Property
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Required
Switch to flag the Property as required
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Encrypted
Switch to flag the Property as Encrypted
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-String
Switch to flag the Property type as String
Type: SwitchParameter
Parameter Sets: String
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-StringDisplay
The form display option for the Property
Type: String
Parameter Sets: String
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Boolean
Switch to flag the Property type as Boolean
Type: SwitchParameter
Parameter Sets: Boolean
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-BooleanDisplay
The form display option for the Property
Type: String
Parameter Sets: Boolean
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Integer
Switch to flag the Property type as Integer
Type: SwitchParameter
Parameter Sets: Integer
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-IntegerDisplay
The form display option for Integer
Type: String
Parameter Sets: Integer
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Decimal
Switch to flag the Property type as Decimal
Type: SwitchParameter
Parameter Sets: Decimal
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DecimalDisplay
The form display option for Decimal
Type: String
Parameter Sets: Decimal
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Datetime
Switch to flag the Property type as Datetime
Type: SwitchParameter
Parameter Sets: Datetime
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DatetimeDisplay
The form display option for Datetime
Type: String
Parameter Sets: Datetime
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-JSON
Property Definition to send in JSON format
Type: String
Parameter Sets: JSON
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False