New-VdcDevice¶

SYNOPSIS¶

Add a new device

SYNTAX¶

New-VdcDevice [-Path] <String> [[-DeviceName] <String[]>] [[-Description] <String>]
 [[-CredentialPath] <String>] [[-Hostname] <String>] [-PassThru] [[-VenafiSession] <PSObject>]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION¶

Add a new device with optional attributes

EXAMPLES¶

EXAMPLE 1¶

$newPolicy = New-VdcDevice -Path '\VED\Policy\MyFolder\device' -PassThru
Create device with full path to device and returning the object created

EXAMPLE 2¶

$policyPath | New-VdcDevice -DeviceName 'myDevice' -Hostname 1.2.3.4
Pipe policy path and provide device details

PARAMETERS¶

-Path¶

Full path to the new device. Alternatively, you can provide just the policy path, but then DeviceName must be provided.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-DeviceName¶

Name of 1 or more devices to create. Path must be of type Policy to use this.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description¶

Device description

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CredentialPath¶

Path to the credential which has permissions to update the device

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Hostname¶

Hostname or IP Address of the device

Type: String
Parameter Sets: (All)
Aliases: IpAddress

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru¶

Return a TppObject representing the newly created policy.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-VenafiSession¶

Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TLSPDC token can also be provided. If providing a TLSPDC token, an environment variable named VDC_SERVER must also be set.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
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

-ProgressAction¶

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters¶

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS¶

Path¶

OUTPUTS¶

TppObject, if PassThru provided¶

NOTES¶

http://VenafiPS.readthedocs.io/en/latest/functions/New-VdcDevice/

https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/New-VdcDevice.ps1

http://VenafiPS.readthedocs.io/en/latest/functions/New-VdcObject/

https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/New-VdcObject.ps1