Set-NBContact
Since
v1.7.1
SYNOPSIS
Update a contact in Netbox
SYNTAX
Set-NBContact [-Id] <UInt64> [[-Name] <String>] [[-Email] <String>] [[-Group] <UInt64>] [[-Title] <String>]
[[-Phone] <String>] [[-Address] <String>] [[-Description] <String>] [[-Comments] <String>] [[-Link] <String>]
[[-Custom_Fields] <Hashtable>] [-Force] [[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates a contact object in Netbox which can be linked to other objects
EXAMPLES
EXAMPLE 1
Set-NBContact -Id 10 -Name 'Leroy Jenkins' -Email 'leroy.jenkins@example.com'
PARAMETERS
-Id
Database ID of the contact to update.
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: True Position: 1 Default value: 0 Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ```
-Name
The contacts full name, e.g "Leroy Jenkins"
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
Email address of the contact
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Group
Database ID of assigned group
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Title
Job title or other title related to the contact
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Phone
Telephone number
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Address
Physical address, usually mailing address
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Description
Short description of the contact
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Comments
Detailed comments. Markdown supported.
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Link
URI related to the contact
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Custom_Fields
Hashtable of custom field values.
```yaml Type: Hashtable Parameter Sets: (All) Aliases:
Required: False Position: 11 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Force
Skip confirmation prompts.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-Tags
{{ Fill Tags Description }}
```yaml Type: Object[] Parameter Sets: (All) Aliases:
Required: False Position: 12 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Raw
Return the raw API response instead of the updated object.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases:
Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ```
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml 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.
```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf
Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-ProgressAction
{{ Fill ProgressAction Description }}
```yaml 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
OUTPUTS
System.Management.Automation.PSObject
NOTES
AddedInVersion: v1.7.1