Set-NBDCIMSite
Since
v4.4.10.0
SYNOPSIS
Update a site in Netbox
SYNTAX
Set-NBDCIMSite [-Id] <UInt64> [[-Name] <String>] [[-Slug] <String>] [[-Status] <String>] [[-Region] <UInt64>]
[[-Group] <UInt64>] [[-Tenant] <UInt64>] [[-Facility] <String>] [[-Time_Zone] <String>]
[[-Description] <String>] [[-Physical_Address] <String>] [[-Shipping_Address] <String>] [[-Latitude] <Double>]
[[-Longitude] <Double>] [[-Comments] <String>] [[-Custom_Fields] <Hashtable>] [[-Owner] <UInt64>] [-Force]
[[-Tags] <Object[]>] [-Raw] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates an existing site with the provided parameters.
EXAMPLES
EXAMPLE 1
Set-NBDCIMSite -Id 1 -Description "Updated description"
EXAMPLE 2
Get-NBDCIMSite -Name "Site1" | Set-NBDCIMSite -Status planned
PARAMETERS
-Id
The ID of the site 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 name of the site
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Slug
The URL-friendly slug for the site
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Status
The operational status of the site (active, planned, staging, decommissioning, retired)
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Region
The region ID this site belongs to
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 5 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Group
The site group ID this site belongs to
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 6 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Tenant
The tenant ID that owns this site
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 7 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Facility
The facility identifier
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 8 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Time_Zone
The time zone for this site
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Description
A description of the site
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Physical_Address
The physical address of the site
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 11 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Shipping_Address
The shipping address for the site
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 12 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Latitude
The latitude coordinate
```yaml Type: Double Parameter Sets: (All) Aliases:
Required: False Position: 13 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Longitude
The longitude coordinate
```yaml Type: Double Parameter Sets: (All) Aliases:
Required: False Position: 14 Default value: 0 Accept pipeline input: False Accept wildcard characters: False ```
-Comments
Additional comments
```yaml Type: String Parameter Sets: (All) Aliases:
Required: False Position: 15 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Custom_Fields
A hashtable of custom fields and values
```yaml Type: Hashtable Parameter Sets: (All) Aliases:
Required: False Position: 16 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Owner
The owner ID for object ownership (Netbox 4.5+ only).
```yaml Type: UInt64 Parameter Sets: (All) Aliases:
Required: False Position: 17 Default value: 0 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: 18 Default value: None Accept pipeline input: False Accept wildcard characters: False ```
-Raw
{{ Fill Raw Description }}
```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: v4.4.10.0