From e45d2665fa0e42342f39233ca05515e9c8a01b16 Mon Sep 17 00:00:00 2001 From: Arnike Date: Sat, 17 Dec 2022 22:51:26 +0300 Subject: [PATCH] Documentation & fixes --- functions/public/Get-Address.ps1 | 5 +++++ functions/public/Get-SubnetUsage.ps1 | 21 ++++++++++++++++----- functions/public/Get-Tag.ps1 | 24 +++++++++++++++++++++--- functions/public/Get-Vrf.ps1 | 19 +++++++++++++++++-- 4 files changed, 59 insertions(+), 10 deletions(-) diff --git a/functions/public/Get-Address.ps1 b/functions/public/Get-Address.ps1 index 9874b20..197bd5b 100644 --- a/functions/public/Get-Address.ps1 +++ b/functions/public/Get-Address.ps1 @@ -1,4 +1,9 @@ function Get-Address { + <# + .SYNOPSIS + + Returns address object. + #> [CmdletBinding(DefaultParameterSetName="ByID")] [OutputType([PS.IPAM.address])] param ( diff --git a/functions/public/Get-SubnetUsage.ps1 b/functions/public/Get-SubnetUsage.ps1 index 731de87..dfcf98d 100644 --- a/functions/public/Get-SubnetUsage.ps1 +++ b/functions/public/Get-SubnetUsage.ps1 @@ -1,20 +1,31 @@ function Get-SubnetUsage { [CmdletBinding(DefaultParameterSetName="ByID")] param ( - [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByCIDR")] + [parameter( + Mandatory=$true, + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + Position=0, + ParameterSetName="ByCIDR" + )] [ValidateScript({[ipaddress] $_.Split("/")[0] -and $_.Split("/")[1] -match "\d{1,2}"})] [ValidateNotNullOrEmpty()] [string] $CIDR, - [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByID")] - [ValidateScript({ $_ -match "^\d+$" })] + [parameter( + Mandatory=$true, + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + Position=0, + ParameterSetName="ByID" + )] [ValidateNotNullOrEmpty()] - [string] + [int] $Id ) process { $_params = @{ - Controller = "subnets" + Controller = [ps.ipam.controllers]::subnets Method = "GET" } switch ($PSCmdlet.ParameterSetName) { diff --git a/functions/public/Get-Tag.ps1 b/functions/public/Get-Tag.ps1 index 8fdd5b5..39d7122 100644 --- a/functions/public/Get-Tag.ps1 +++ b/functions/public/Get-Tag.ps1 @@ -11,15 +11,33 @@ function Get-Tag { [CmdletBinding(DefaultParameterSetName="NoParams")] [OutputType([PS.IPAM.Tag])] param ( - [parameter(Mandatory=$false,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByID")] + [parameter( + Mandatory=$false, + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + Position=0, + ParameterSetName="ByID" + )] [ValidateNotNullOrEmpty()] [int] $Id, - [parameter(Mandatory=$false,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByAddressObject")] + [parameter( + Mandatory=$false, + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + Position=0, + ParameterSetName="ByAddressObject" + )] [ValidateNotNullOrEmpty()] [PS.IPAM.Address] $AddressObject, - [parameter(Mandatory=$false,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="BySubnetObject")] + [parameter( + Mandatory=$false, + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + Position=0, + ParameterSetName="BySubnetObject" + )] [ValidateNotNullOrEmpty()] [PS.IPAM.Subnetwork] $SubnetObject diff --git a/functions/public/Get-Vrf.ps1 b/functions/public/Get-Vrf.ps1 index 9ff2c78..96c23fb 100644 --- a/functions/public/Get-Vrf.ps1 +++ b/functions/public/Get-Vrf.ps1 @@ -1,8 +1,23 @@ function Get-Vrf { - [CmdletBinding(DefaultParameterSetName="ByID")] + <# + .SYNOPSIS + + Returns VRF object. + + .DESCRIPTION + + Returns VRF by id. Or leave it empty to get all VRFs. + #> + [CmdletBinding(DefaultParameterSetName="NoParams")] [OutputType([PS.IPAM.Vrf])] param ( - [parameter(Mandatory=$false,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByID")] + [parameter( + Mandatory=$true, + ValueFromPipeline=$true, + ValueFromPipelineByPropertyName=$true, + Position=0, + ParameterSetName="ByID" + )] [ValidateNotNullOrEmpty()] [int] $Id