powershellscripts.com

Tutorials  PowerShell Cmdlet Help for New-CustomField



NAME
New-CustomField

SYNOPSIS
Creates a new custom field for a particular inventory item type.

SYNTAX
New-CustomField [-Entity] [-Name] [[-Value] ] [-Global] [-WhatIf] [-Confirm] [ monParameters>]


DESCRIPTION
This cmdlet is deprecated and scheduled for removal. Creates a custom field for the object types that are provided
by the Entity parameter.


PARAMETERS
-Entity
Specify the inventory objects for which you want to create a new custom field.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Name
Specify the name of the new custom field.

Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Value
Specify the value of the new custom field.

Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Global
Indicate that the new custom field apply to all types of objects.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.

Required? false
Position? named
Default value $true
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
InventoryItem


NOTES


In VirtualCenter 2.0, custom fields are global and apply to all objects. For example, if a custom field is crea
ted for a Folder it is created for all inventory items (VM, VMHost, and so on).
In VirtualCenter 2.5, you can define custom fields on a per-type basis. For example, if a custom field is creat
ed for a Folder it is created only for the Folder objects. VM, VMHost, and other objects do not have this cust
om field.

-------------- Example 1 --------------

C:\PS>New-CustomField -Entity VM -Name CPUMaxLoad -Value 300


Creates a custom field named CPUMaxLoad for the VM virtual machine, and sets it initial value to 300. The command r
eturns the virtual machine VM, to which the new custom field belongs.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/New-CustomField.html
Remove-CustomField
Set-CustomField