Documentation

functions/public/Assign-Tag.ps1

@@ -1,11 +1,27 @@
 function Assign-Tag {
+    <#
+        .SYNOPSIS
+
+        Assign tag to address.
+
+        .PARAMETER Tag
+        Tag object to assign.
+    #>
     [CmdletBinding()]
     param (
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0)]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=0
+        )]
         [ValidateNotNullOrEmpty()]
         [PS.IPAM.Address]
         $AddressObject,
-        [parameter(Mandatory=$true,Position=1)]
+        [parameter(
+            Mandatory=$true,
+            Position=1
+        )]
         [ValidateNotNullOrEmpty()]
         [PS.IPAM.Tag]
         $Tag

functions/public/Get-Address.ps1

@@ -2,28 +2,70 @@ function Get-Address {
     [CmdletBinding(DefaultParameterSetName="ByID")]
     [OutputType([PS.IPAM.address])]
     param (
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByID")]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=0,
+            ParameterSetName="ByID"
+        )]
         [ValidateNotNullOrEmpty()]
         [int]
         $Id,
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByIP")]
+        [parameter(
-        [parameter(Mandatory=$false,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=1,ParameterSetName="BySubnetId")]
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=0,
+            ParameterSetName="ByIP"
+        )]
+        [parameter(
+            Mandatory=$false,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=1,
+            ParameterSetName="BySubnetId"
+        )]
         [ValidateNotNullOrEmpty()]
         [ipaddress]
         $IP,
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByHostName")]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=0,
+            ParameterSetName="ByHostName"
+        )]
         [ValidateNotNullOrEmpty()]
         [string]
         $HostName,
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="ByTag")]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=0,
+            ParameterSetName="ByTag"
+        )]
         [ValidateNotNullOrEmpty()]
         [int]
         $TagId,
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="BySubnetId")]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=0,
+            ParameterSetName="BySubnetId"
+        )]
         [ValidateNotNullOrEmpty()]
         [int]
         $SubnetId,
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0,ParameterSetName="BySubnetCIDR")]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=0,
+            ParameterSetName="BySubnetCIDR"
+        )]
         [ValidateScript({[ipaddress] $_.Split("/")[0] -and $_.Split("/")[1] -match "\d{1,2}"})]
         [ValidateNotNullOrEmpty()]
         [string]

functions/public/Get-Nameserver.ps1

@@ -7,9 +7,6 @@ function Get-Nameserver {
         $Id
     )
     process {
-        [string[]]$visiblePropertiesList = @('Id','Name','Address','Description')
-        $visibleProperties = [System.Management.Automation.PSPropertySet]::new('DefaultDisplayPropertySet',$visiblePropertiesList)
-
         $_params = @{
             Controller    = [PS.IPAM.controllers]::tools
             SubController = [PS.IPAM.subcontrollers]::nameservers
@@ -21,8 +18,7 @@ function Get-Nameserver {
         $_identifiers = @($_nameserverId)
         $_params.Add("Identifiers",$_identifiers)
 
-        Invoke-Request @_params | Select-Object  @{n="address";e={$_.namesrv1}},* | Select-Object -ExcludeProperty namesrv1 | `
+        Invoke-Request @_params
-            Add-Member -MemberType MemberSet -Name PSStandardMembers -Value $visibleProperties -PassThru
     }
 }
 Export-ModuleMember -Function Get-Nameserver

functions/public/Get-Tag.ps1

@@ -1,4 +1,13 @@
 function Get-Tag {
+    <#
+        .SYNOPSIS
+
+        Return address tag.
+
+        .DESCRIPTION
+
+        Return address tag by id, address object or subnetwork object. Or leave it empty at take all tags at once.
+    #>
     [CmdletBinding(DefaultParameterSetName="NoParams")]
     [OutputType([PS.IPAM.Tag])]
     param (

functions/public/Get-Vlan.ps1

@@ -1,8 +1,20 @@
 function Get-Vlan {
-    [CmdletBinding(DefaultParameterSetName="ByID")]
+    <#
+        .SYNOPSIS
+
+        Return vlan object.
+
+        .DESCRIPTION
+
+        Return vlan object by vlanId, vlan number, l2domainId (return all vlans in domain), subnet object or l2domain object
+
+        .PARAMETER Number
+        Vlan tag
+    #>
+    [CmdletBinding(DefaultParameterSetName="NoParams")]
     [OutputType([PS.IPAM.Vlan])]
     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,

functions/public/New-Session.ps1

@@ -1,20 +1,72 @@
 function New-Session {
+    <#
+        .SYNOPSIS
+
+        Creates new session to phpIPAM instance.
+
+        .DESCRIPTION
+
+        Creates new session to phpIPAM instance by provided credentials or token.
+
+        .PARAMETER URL
+        Base URL of phpIPAM instance.
+        Example - http://ipam.example.com
+
+        .PARAMETER AppID
+        API id (specified in phpIPAM api settings)
+
+        .PARAMETER Token
+        User token foor authorization
+
+        .PARAMETER IgnoreSSL
+        Ignore SSL errors
+
+        .OUTPUTS
+        None. New-Session does not generate any output.
+    #>
     [CmdletBinding(DefaultParameterSetName="Credentials")]
     param (
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=0)]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=0
+        )]
         [ValidateNotNullOrEmpty()]
         [validatescript({$_.startswith("http")})]
         [string]$URL,
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=1)]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=1
+        )]
         [ValidateNotNullOrEmpty()]
         [string]$AppID,
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=2,ParameterSetName="Credentials")]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=2,
+            ParameterSetName="Credentials"
+        )]
         [ValidateNotNullOrEmpty()]
         [pscredential]$Credentials,
-        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=2,ParameterSetName="Token")]
+        [parameter(
+            Mandatory=$true,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=2,
+            ParameterSetName="Token"
+        )]
         [ValidateNotNullOrEmpty()]
         [string]$Token,
-        [parameter(Mandatory=$false,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,Position=3)]
+        [parameter(
+            Mandatory=$false,
+            ValueFromPipeline=$true,
+            ValueFromPipelineByPropertyName=$true,
+            Position=3
+        )]
         [switch]$IgnoreSSL = $false
     )
     switch ($PSCmdlet.ParameterSetName) {

functions/public/New-Subnet.ps1

@@ -1,12 +1,7 @@
 function New-Subnet {
     [CmdletBinding()]
     param (
-        [parameter(
+        [parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true,HelpMessage="CIDR of subnet in dotted format (e.g 10.10.10.0/24)",Position=0)]
-            Mandatory=$true,
-            ValueFromPipeline=$true,
-            ValueFromPipelineByPropertyName=$true,
-            HelpMessage="CIDR of subnet in dotted format (e.g 10.10.10.0/24)",
-            Position=0)]
         [ValidateScript({[ipaddress] $_.Split("/")[0] -and $_.Split("/")[1] -match "\d{1,2}"})]
         [ValidateNotNullOrEmpty()]
         [string]

types/types.ps1xml

@@ -154,9 +154,10 @@
             <Name>DefaultDisplayPropertySet</Name>
             <ReferencedProperties>
               <Name>Id</Name>
-              <Name>Name</Name>
+              <Name>Subnet</Name>
-              <Name>DomainId</Name>
+              <Name>Mask</Name>
-              <Name>Number</Name>
+              <Name>SectionId</Name>
+              <Name>Description</Name>
             </ReferencedProperties>
           </PropertySet>
           <PropertySet>