New-ParameterInfo
Creates a PowerShell object representing a Crescendo Parameter definition.
Syntax
Default (Default)
New-ParameterInfo
[-Name] <String>
[-OriginalName] <String>
[<CommonParameters>]
Description
Creates a PowerShell object representing a Crescendo Parameter definition. You can assign values to the properties of the object. The resulting object can be added to the Parameters property of a command object or it can be converted to JSON to be inserted in the configuration file.
Examples
Example 1 - Create a new parameter object
$param = New-ParameterInfo -Name ComputerName -OriginalName '--targethost'
$param
Name : ComputerName
OriginalName : --targethost
OriginalText :
Description :
DefaultValue :
DefaultMissingValue :
ApplyToExecutable : False
ParameterType : object
AdditionalParameterAttributes :
Mandatory : False
ParameterSetName :
Aliases :
Position : 2147483647
OriginalPosition : 0
ValueFromPipeline : False
ValueFromPipelineByPropertyName : False
ValueFromRemainingArguments : False
NoGap : False
Parameters
-Name
The name of the parameter for the cmdlet being defined.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OriginalName
The original parameter used by the native executable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.