diff --git a/functions/public/Set-Address.ps1 b/functions/public/Set-Address.ps1 index f47ef10..fa3c2de 100644 --- a/functions/public/Set-Address.ps1 +++ b/functions/public/Set-Address.ps1 @@ -1,57 +1,140 @@ function Set-Address { + <# + .SYNOPSIS + Edit address object. + + .PARAMETER Id + Id of subnet address belongs to. + + .PARAMETER AddressObject + Address object to edit. + + .PARAMETER Gateway + Defines if address is presented as gateway + + .PARAMETER Description + Address description. + #> + [OutputType([PS.IPAM.address])] [CmdletBinding(DefaultParameterSetName="ById")] param ( - [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,HelpMessage="Id of subnet address belongs to",Position=0,ParameterSetName="ById")] + [parameter( + Mandatory=$true, + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + Position=0, + ParameterSetName="ById" + )] [ValidateNotNullOrEmpty()] [int] $Id, - [parameter(Mandatory=$false,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByAddressObject")] + [parameter( + Mandatory=$true, + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + Position=0, + ParameterSetName="ByAddressObject" + )] [ValidateNotNullOrEmpty()] [PS.IPAM.Address] $AddressObject, - [parameter(Mandatory=$false,HelpMessage="Defines if address is presented as gateway",Position=1)] + [parameter( + Position=1 + )] + [parameter( + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + ParameterSetName="ById" + )] [bool] $Gateway, - [parameter(Mandatory=$false,HelpMessage="Address description",Position=2)] + [parameter( + Position=2 + )] + [parameter( + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + ParameterSetName="ById" + )] [ValidateNotNullOrEmpty()] [string] $Description, - [parameter(Mandatory=$false,HelpMessage="Address hostname",Position=3)] + [parameter( + Mandatory=$false, + HelpMessage="Address hostname", + Position=3 + )] [ValidateNotNullOrEmpty()] [string] $Hostname, - [parameter(Mandatory=$false,HelpMessage="Mac address",Position=4)] + [parameter( + Mandatory=$false, + HelpMessage="Mac address", + Position=4 + )] [ValidateScript({ $_.Replace(":","") -match "^$('([A-F0-9]{2})' * 6)$" })] [ValidateNotNullOrEmpty()] [string] $MAC, - [parameter(Mandatory=$false,HelpMessage="Address owner",Position=5)] + [parameter( + Mandatory=$false, + HelpMessage="Address owner", + Position=5 + )] [ValidateNotNullOrEmpty()] [string] $Owner, - [parameter(Mandatory=$false,HelpMessage="Id of subnet address belongs to",Position=6)] + [parameter( + Mandatory=$false, + HelpMessage="Id of subnet address belongs to", + Position=6 + )] [ValidateNotNullOrEmpty()] [int] $TagId, - [parameter(Mandatory=$false,HelpMessage="Controls if PTR should not be created",Position=7)] + [parameter( + Mandatory=$false, + HelpMessage="Controls if PTR should not be created", + Position=7 + )] [bool] $PTRIgnore, - [parameter(Mandatory=$false,HelpMessage="Id of PowerDNS PTR record",Position=8)] + [parameter( + Mandatory=$false, + HelpMessage="Id of PowerDNS PTR record", + Position=8 + )] [ValidateNotNullOrEmpty()] [int] $PTRId, - [parameter(Mandatory=$false,HelpMessage="Note",Position=9)] + [parameter( + Mandatory=$false, + HelpMessage="Note", + Position=9 + )] [ValidateNotNullOrEmpty()] [string] $Note, - [parameter(Mandatory=$false,HelpMessage="Exclude this address from status update scans (ping)",Position=10)] + [parameter( + Mandatory=$false, + HelpMessage="Exclude this address from status update scans (ping)", + Position=10 + )] [bool] $ExcludePing, - [parameter(Mandatory=$false,HelpMessage="Id of device address belongs to",Position=11)] + [parameter( + Mandatory=$false, + HelpMessage="Id of device address belongs to", + Position=11 + )] [ValidateNotNullOrEmpty()] [int] $DeviceId, - [parameter(Mandatory=$false,HelpMessage="Port",Position=12)] + [parameter( + Mandatory=$false, + HelpMessage="Port", + Position=12 + )] [ValidateNotNullOrEmpty()] [string] $Port, @@ -103,7 +186,7 @@ function Set-Address { Invoke-Request @_params } finally { - Get-Address -Id $_id + Get-Address -id $_id } } }