PSPHPIPAM

https://github.com/yoke88/psphpipam
Admin
A PowerShell REST client module for PHPIPAM that enables automation and management of PHPIPAM tasks...
Tokens:6,681
Snippets:34
Trust Score:6.3
License:MIT
Update:9 months ago
Show doc for...
Tokens:
Raw
### Build PSPHPIPAM Dev Environment (Bash/PowerShell)

Source: https://github.com/yoke88/psphpipam/blob/master/Docs/1.create_dev_env_with_vagrant.md

Scripts to build the PSPHPIPAM development environment. These scripts are designed to be executed after cloning the repository and ensuring Vagrant and VirtualBox are installed. The Linux script is './buildenv.sh' and the Windows script is './buildenv.ps1'.

```bash
# clone this git repo
git clone https://github.com/yoke88/PSPHPIPAM

cd PSPHPIPAM

# suppose you have install virtualbox and vagrant
# change the line 'config.vm.box = "centos7"' in Vagrantfile.host to "config.vm.box ="generic/centos7" or something you can find in https://app.vagrantup.com/boxes/search?provider=virtualbox&q=centos7&sort=downloads&utf8=%E2%9C%93


# if your are on linux,using below command

./buildenv.sh

# if you using windows, using below command
# ./buildenv.ps1
```

```powershell
# clone this git repo
git clone https://github.com/yoke88/PSPHPIPAM

cd PSPHPIPAM

# suppose you have install virtualbox and vagrant
# change the line 'config.vm.box = "centos7"' in Vagrantfile.host to "config.vm.box ="generic/centos7" or something you can find in https://app.vagrantup.com/boxes/search?provider=virtualbox&q=centos7&sort=downloads&utf8=%E2%9C%93


# if your are on linux,using below command
# ./buildenv.sh

# if you using windows, using below command
./buildenv.ps1
```

--------------------------------

### Vagrant Environment Provisioning Output

Source: https://github.com/yoke88/psphpipam/blob/master/Docs/1.create_dev_env_with_vagrant.md

Output from the Vagrant command indicating the provisioning status of different services (mysql, phpipam, nginx) using the Docker provider. It confirms that containers are being brought up and notes that provisioners are skipped as containers do not support SSH.

```text
Bringing machine 'mysql' up with 'docker' provider...
Bringing machine 'phpipam' up with 'docker' provider...
Bringing machine 'nginx' up with 'docker' provider...
==> mysql: Docker host is required. One will be created if necessary...
    mysql: Docker host VM is already ready.
==> mysql: Provisioners will not be run since container doesn't support SSH.
==> phpipam: Docker host is required. One will be created if necessary...
    phpipam: Docker host VM is already ready.
==> phpipam: Provisioners will not be run since container doesn't support SSH.
==> nginx: Docker host is required. One will be created if necessary...
    nginx: Docker host VM is already ready.
==> nginx: Provisioners will not be run since container doesn't support SSH.

==> nginx: Machine 'nginx' has a post `vagrant up` message. This is a message
==> nginx: from the creator of the Vagrantfile, and not from Vagrant itself:
==> nginx: 
==> nginx: 
==> nginx:   ========================================================================
==> nginx:     config the phpipam env at      : http://127.0.0.1:8080 and https://127.0.0.1:4433
==> nginx:     the default mysql root pass is : my-secret-pw-Oo
==> nginx:   ========================================================================
==> nginx:  
```

--------------------------------

### Get All PhpIpamSections

Source: https://context7.com/yoke88/psphpipam/llms.txt

Retrieves a list of all sections defined in PHPIPAM. Useful for obtaining an overview of organizational structure or for iterating through all sections.

```powershell
# Get all sections
$sections = Get-PhpIpamSections

# List section names
$sections | ForEach-Object {
    Write-Host "Section: $($_.name) (ID: $($_.id))"
}

# Find specific section by name
$customerSection = Get-PhpIpamSections | Where-Object { $_.name -eq "Customers" }

# Count total sections
$sectionCount = (Get-PhpIpamSections).Count
Write-Host "Total sections: $sectionCount"

# Returns: Array of all section objects
```

--------------------------------

### Get First Free IP Address by Subnet ID

Source: https://context7.com/yoke88/psphpipam/llms.txt

Retrieves the first available IP address within a specified subnet, identified by its ID. Useful for automatic IP allocation and can be used in pipeline operations.

```powershell
# Get first free IP by subnet ID
$freeIP = Get-PhpIpamSubnetFirstFreeByID -ID 10

# Pipeline usage with subnet creation
$subnet = Get-PhpIpamSubnet -CIDR "192.168.10.0/24"
$freeIP = Get-PhpIpamSubnetFirstFreeByID -ID $subnet.id
New-PhpIpamAddress -params @{
    subnetId = $subnet.id
    ip = $freeIP
    hostname = "autoassigned"
}

# Using alias
$freeIP = Get-PhpIpamSubnetFirst_FreeByID -ID 10

# Returns: String containing the next available IP address (e.g., "192.168.10.15")
```

--------------------------------

### Get PhpIpamSubnet by ID or CIDR

Source: https://context7.com/yoke88/psphpipam/llms.txt

Retrieves detailed information about a subnet using its ID or CIDR notation (IPv4 or IPv6). Supports aliases for convenience.

```powershell
# Get subnet by ID
$subnet = Get-PhpIpamSubnet -ID 1

# Get subnet by CIDR
$subnet = Get-PhpIpamSubnet -CIDR "192.168.9.0/23"
$subnet = Get-PhpIpamSubnet -CIDR "fd13:6d20:29dc:cf27::/64"

# Using aliases
$subnet = Get-PhpIpamSubnetByID -ID 1
$subnet = Get-PhpIpamSubnetByCIDR -CIDR "10.0.0.0/8"
```

--------------------------------

### Get IP Address Information (PowerShell)

Source: https://context7.com/yoke88/psphpipam/llms.txt

Retrieves IP address details from PHPIPAM using IP address, ID, or hostname. Supports pipeline input and flexible querying through multiple parameter sets and aliases. The output includes detailed information about the IP address configuration.

```powershell
# Get address by IP
$address = Get-PhpIpamAddress -IP "192.168.10.2"

# Get address by ID
$address = Get-PhpIpamAddress -ID 123

# Get address by hostname
$address = Get-PhpIpamAddress -HostName "server01"

# Using aliases
$address = Get-PhpIpamAddressByIP -IP "192.168.10.2"
$address = Get-PhpIpamAddressByID -ID 123
$address = Get-PhpIpamAddressByHostname -HostName "webserver"

# Output example:
# id          : 123
# subnetId    : 10
# ip          : 192.168.10.2
# description : Web Server
# hostname    : server01
# mac         : 00:50:56:00:00:01
# owner       : IT Department
# tag         : 2
# state       : 1
```

--------------------------------

### Get All Subnets by Section ID

Source: https://context7.com/yoke88/psphpipam/llms.txt

Retrieves all subnets belonging to a specific section in PHPIPAM, identified by its ID. Useful for inventory and reporting, and can be piped for further processing.

```powershell
# Get all subnets in section
$subnets = Get-PhpIpamSubnetsBySectionID -ID 2

# List subnet details
$subnets | ForEach-Object {
    Write-Host "Subnet: $($_.subnet)/$($_.mask) - $($_.description)"
}

# Count subnets per section
$sections = Get-PhpIpamSections
foreach ($section in $sections) {
    $count = (Get-PhpIpamSubnetsBySectionID -ID $section.id).Count
    Write-Host "Section $($section.name): $count subnets"
}

# Returns: Array of subnet objects
```

--------------------------------

### Get PhpIpamSection by Name or ID

Source: https://context7.com/yoke88/psphpipam/llms.txt

Retrieves details for a specific section in PHPIPAM using its name or ID. Supports aliases and pipeline operations, allowing retrieval after creation.

```powershell
# Get section by name
$section = Get-PhpIpamSection -Name "Customers"

# Get section by ID
$section = Get-PhpIpamSection -ID 8

# Explicit parameter set usage
$section = Get-PhpIpamSection -name "section2"
$section = Get-PhpIpamSection -id 8

# Using aliases
$section = Get-PhpIpamSectionByName -Name "Customers"
$section = Get-PhpIpamSectionByID -ID 8

# Pipeline usage - create and retrieve
New-PhpIpamSection -Param @{"name"="section3"} | Get-PhpIpamSection
```

--------------------------------

### Execute Custom API Requests in PHPIPAM

Source: https://context7.com/yoke88/psphpipam/llms.txt

Provides a low-level interface for executing direct API calls to PHPIPAM, offering flexibility for operations not covered by higher-level cmdlets. Supports GET, POST, PATCH, and DELETE methods with various options for controllers, identifiers, and parameters. The function returns a PSCustomObject containing code, success status, message, data, and time.

```powershell
# GET request - retrieve sections
$result = Invoke-PhpIpamExecute -method get -controller sections

# GET with identifiers - get specific section
$result = Invoke-PhpIpamExecute -method get -controller sections -identifiers @(4)

# GET with query parameters
$result = Invoke-PhpIpamExecute -method get -controller sections -params @{id=10}

# POST request - create resource
$result = Invoke-PhpIpamExecute -method post -controller subnets -params @{
    sectionId = 1
    subnet = '192.168.20.0'
    mask = 24
}

# PATCH request - update resource
$result = Invoke-PhpIpamExecute -method patch \
    -controller addresses \
    -identifiers @(279) \
    -params @{description="Updated"}

# DELETE request - remove resource
$result = Invoke-PhpIpamExecute -method delete -controller addresses -identifiers @(123)

# Complex endpoint - /api/my_app/sections/4/subnets/
$result = Invoke-PhpIpamExecute -method get \
    -controller sections \
    -identifiers @(4,'subnets')

# Returns: PSCustomObject with properties: code, success, message, data, time
```

--------------------------------

### Remove Subnet from PHPIPAM

Source: https://context7.com/yoke88/psphpipam/llms.txt

Deletes a subnet from PHPIPAM. The removal may fail if the subnet is not empty, depending on PHPIPAM's configuration. Subnets can be removed by their ID or CIDR notation, after retrieving their ID. The cmdlet also supports pipeline removal and includes an example of cleaning up addresses before removing the subnet.

```powershell
# Remove subnet by ID
Remove-PhpIpamSubnet -ID 15

# Remove subnet by CIDR (get ID first)
$subnet = Get-PhpIpamSubnet -CIDR "192.168.10.0/24"
Remove-PhpIpamSubnet -ID $subnet.id

# Pipeline removal
Get-PhpIpamSubnet -CIDR "192.168.10.0/24" | Remove-PhpIpamSubnet

# Clean up - remove addresses before removing subnet
$subnet = Get-PhpIpamSubnet -CIDR "192.168.10.0/24"
Get-PhpIpamSubnetAddressesByID -ID $subnet.id | Remove-PhpIpamAddress
Remove-PhpIpamSubnet -ID $subnet.id

# Returns: $true on success
```

--------------------------------

### Create PHPIPAM API Session (PowerShell)

Source: https://context7.com/yoke88/psphpipam/llms.txt

Establishes an authenticated session with the PHPIPAM API. Supports credential-based token, static app key, and encrypted request authentication. Requires the PHPIPAM API URL, App ID, and appropriate authentication credentials. Returns $true on success and $false on failure.

```powershell
# Credential-based authentication (SSL with user token)
New-PhpIpamSession -useCredAuth \
    -PhpIpamApiUrl "https://ipam.example.com/api" \
    -AppID "myapp" \
    -userName "admin" \
    -password "secretpassword"

# Static app key authentication (SSL with app code token)
New-PhpIpamSession -UseStaticAppKeyAuth \
    -PhpIpamApiUrl "https://ipam.example.com/api" \
    -AppID "myapp" \
    -AppKey "de36328dbe3df0bc7d39ff2306e9aesa"

# Debug mode to troubleshoot connection issues
New-PhpIpamSession -useCredAuth \
    -PhpIpamApiUrl "http://127.0.0.1/api" \
    -AppID "script2" \
    -userName "admin" \
    -password "password" \
    -debug

# Returns: $true on success, $false on failure
```

--------------------------------

### Create New IP Address (PowerShell)

Source: https://context7.com/yoke88/psphpipam/llms.txt

Creates a new IP address entry in PHPIPAM within a specified subnet. Requires a hashtable containing 'subnetId' and 'ip', with optional fields for hostname, description, MAC address, and custom fields. Supports pipeline input to use the first free IP found in a subnet.

```powershell
# Basic address creation
$newAddress = New-PhpIpamAddress -params @{
    subnetId = 10
    ip = '192.168.10.2'
}

# Address with full details
$newAddress = New-PhpIpamAddress -params @{
    subnetId = 10
    ip = '192.168.10.5'
    hostname = 'webserver01'
    description = 'Production web server'
    mac = '00:50:56:00:00:05'
    owner = 'Web Team'
    tag = 2
}

# Pipeline example - get first free IP and create address
$subnet = Get-PhpIpamSubnet -ID 10
$freeIP = Get-PhpIpamSubnetFirstFreeByID -ID $subnet.id
$newAddress = New-PhpIpamAddress -params @{
    subnetId = $subnet.id
    ip = $freeIP
    hostname = 'autoserver'
}

# Returns the created address object with all fields populated
```

--------------------------------

### Subnet Management

Source: https://context7.com/yoke88/psphpipam/llms.txt

Provides cmdlets for removing subnets from PHPIPAM. Subnets must be empty or removal may fail.

```APIDOC
## Remove Subnet

### Description
Deletes a subnet from PHPIPAM. The subnet must be empty or the removal may fail depending on PHPIPAM configuration.

### Method
`Remove-PhpIpamSubnet`

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The ID of the subnet to remove.

### Request Example
```powershell
Remove-PhpIpamSubnet -ID 15
```

### Response
- **success** (boolean) - Returns `$true` on success.
```

--------------------------------

### Create New Section in PHPIPAM

Source: https://context7.com/yoke88/psphpipam/llms.txt

Creates a new organizational section within PHPIPAM, used for grouping related subnets. This cmdlet supports basic creation, adding descriptions, and full configuration including master section, strict mode, VLAN visibility, and permissions. It can be used standalone or piped to other cmdlets. Returns the created section object.

```powershell
# Basic section creation
$newSection = New-PhpIpamSection -Param @{
    "name" = "section2"
}

# Section with description
$newSection = New-PhpIpamSection -Param @{
    "name" = "Customers"
    "description" = "Customer networks"
}

# Section with full configuration
$newSection = New-PhpIpamSection -Param @{
    "name" = "DataCenter"
    "description" = "Data center networks"
    "masterSection" = 0
    "strictMode" = 1
    "showVLAN" = 1
    "permissions" = '{"2":"3","1":"2"}'
}

# Pipeline usage
New-PhpIpamSection -Param @{"name"="section3"} | Get-PhpIpamSection

# Returns the created section object with all fields populated
```

--------------------------------

### Create New PhpIpamSubnet

Source: https://context7.com/yoke88/psphpipam/llms.txt

Creates a new subnet within a specified section in PHPIPAM. Requires at least section ID, subnet address, and mask. Supports full configuration options and IPv6.

```powershell
# Basic subnet creation
$newSubnet = New-PhpIpamSubnet -Params @{
    sectionId = 1
    subnet = '192.168.10.0'
    mask = 24
}

# Subnet with full configuration
$newSubnet = New-PhpIpamSubnet -Params @{
    sectionId = 2
    subnet = '10.20.30.0'
    mask = 24
    description = 'Development Network'
    vlanId = 200
    allowRequests = 1
    showName = 1
    permissions = '{"2":"2","3":"1"}'
}

# IPv6 subnet
$newSubnet = New-PhpIpamSubnet -Params @{
    sectionId = 1
    subnet = 'fd13:6d20:29dc:cf27::'
    mask = 64
    description = 'IPv6 Network'
}

# Returns the created subnet object with ID and all fields
```

--------------------------------

### Section Management

Source: https://context7.com/yoke88/psphpipam/llms.txt

Provides cmdlets for creating, updating, and removing organizational sections in PHPIPAM. Sections are used to group related subnets.

```APIDOC
## Create New Section

### Description
Creates a new organizational section in PHPIPAM. Sections are used to group related subnets.

### Method
`New-PhpIpamSection`

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new section.
- **description** (string) - Optional - A description for the section.
- **masterSection** (integer) - Optional - The ID of the master section (defaults to 0).
- **strictMode** (integer) - Optional - Enables strict mode (1 for enabled, 0 for disabled).
- **showVLAN** (integer) - Optional - Enables VLAN display (1 for enabled, 0 for disabled).
- **permissions** (string) - Optional - JSON string representing user permissions.

### Request Example
```powershell
New-PhpIpamSection -Param @{
    "name" = "section2"
    "description" = "Customer networks"
}
```

### Response
Returns the created section object with all fields populated.
```

```APIDOC
## Update Section

### Description
Updates an existing section with new information. Requires section ID and fields to modify.

### Method
`Update-PhpIpamSection`

### Parameters
#### Request Body
- **id** (integer) - Required - The ID of the section to update.
- **name** (string) - Optional - The new name for the section.
- **description** (string) - Optional - The new description for the section.
- **masterSection** (integer) - Optional - The ID of the master section.
- **strictMode** (integer) - Optional - Enables strict mode (1 for enabled, 0 for disabled).
- **showVLAN** (integer) - Optional - Enables VLAN display (1 for enabled, 0 for disabled).
- **permissions** (string) - Optional - JSON string representing user permissions.

### Request Example
```powershell
Update-PhpIpamSection -Params @{
    id = 8
    name = "NewCustomers"
    description = "Reorganized customer section"
}
```

### Response
- **success** (boolean) - Returns `$true` on success.
```

```APIDOC
## Remove Section

### Description
Deletes a section from PHPIPAM by its ID. Note that sections containing subnets may need subnets removed first.

### Method
`Remove-PhpIpamSection`

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The ID of the section to remove.

### Request Example
```powershell
Remove-PhpIpamSection -ID 5
```

### Response
- **success** (boolean) - Returns `$true` on success.
```

--------------------------------

### Execute Custom API Requests

Source: https://context7.com/yoke88/psphpipam/llms.txt

A low-level function for executing direct API calls to PHPIPAM. This provides flexibility for operations not covered by higher-level cmdlets.

```APIDOC
## Execute Custom API Requests

### Description
Executes direct API calls to PHPIPAM.

### Method
`Invoke-PhpIpamExecute`

### Parameters
#### Request Body
- **method** (string) - Required - The HTTP method (e.g., GET, POST, PATCH, DELETE).
- **controller** (string) - Required - The API controller (e.g., sections, subnets, addresses).
- **identifiers** (array) - Optional - An array of identifiers for specific resources.
- **params** (hashtable) - Optional - Query parameters or request body data.

### Request Example
```powershell
# GET request - retrieve sections
Invoke-PhpIpamExecute -method get -controller sections

# POST request - create resource
Invoke-PhpIpamExecute -method post -controller subnets -params @{
    sectionId = 1
    subnet = '192.168.20.0'
    mask = 24
}
```

### Response
- **code** (integer) - The HTTP status code of the response.
- **success** (boolean) - Indicates if the request was successful.
- **message** (string) - A message describing the outcome.
- **data** (object) - The data returned by the API.
- **time** (string) - The time taken for the API call.
```

--------------------------------

### Update IP Address (PowerShell)

Source: https://context7.com/yoke88/psphpipam/llms.txt

Updates an existing IP address in PHPIPAM by its ID. Accepts a hashtable with the address 'id' and any fields to be modified, such as hostname, description, or owner. Supports pipeline input and provides the updated address object upon successful modification.

```powershell
# Update address description
$address = Get-PhpIpamAddress -IP "192.168.10.2"
Update-PhpIpamAddress -params @{
    id = $address.id
    description = "Updated description"
}

# Update multiple fields
Update-PhpIpamAddress -params @{
    id = 279
    hostname = "newserver"
    description = "Updated server"
    owner = "DevOps Team"
}

# Using alias
Update-PhpIpamAddressByID -params @{
    id = 123
    hostname = "testhost"
}

# Pipeline usage
$address = Get-PhpIpamAddress -IP "192.168.10.2"
$updated = Update-PhpIpamAddress -params @{
    id = $address.id
    hostname = "testhost"
}

# Returns updated address object with all current values
```

--------------------------------

### Remove PhpIpamAddress by ID or IP

Source: https://context7.com/yoke88/psphpipam/llms.txt

Removes an IP address from PHPIPAM using its ID or by first retrieving the ID using its IP address. Supports pipeline operations for bulk deletion.

```powershell
# Delete by ID
Remove-PhpIpamAddress -id 123

# Delete by IP (get ID first)
$address = Get-PhpIpamAddress -IP "192.168.10.2"
Remove-PhpIpamAddress -id $address.id

# Pipeline deletion
Get-PhpIpamAddress -IP "192.168.10.2" | Remove-PhpIpamAddress

# Bulk deletion - remove all addresses
Get-PhpIpamAddresses | Remove-PhpIpamAddress

# Returns: $true on success
```

--------------------------------

### Update Section in PHPIPAM

Source: https://context7.com/yoke88/psphpipam/llms.txt

Updates an existing section in PHPIPAM. This cmdlet requires the section's ID and the fields to be modified. It can update a single field like the description or multiple fields simultaneously. The function returns `$true` on successful update.

```powershell
# Update section description
$section = Get-PhpIpamSection -Name "Customers"
Update-PhpIpamSection -Params @{
    id = $section.id
    description = "Updated customer networks"
}

# Update multiple fields
Update-PhpIpamSection -Params @{
    id = 8
    name = "NewCustomers"
    description = "Reorganized customer section"
    showVLAN = 1
}

# Returns: $true on success
```

--------------------------------

### Remove IP Address (PowerShell)

Source: https://context7.com/yoke88/psphpipam/llms.txt

Deletes an IP address from PHPIPAM using its unique ID. This function is designed to be straightforward and supports pipeline input, allowing for the removal of multiple IP addresses in batch operations.

```powershell
# Example usage (assuming $address.id contains the ID of the address to remove)
# Remove-PhpIpamAddress -ID $address.id

# Example using pipeline input
# Get-PhpIpamAddress -IP "192.168.10.10" | Remove-PhpIpamAddress
```

--------------------------------

### Remove Section from PHPIPAM

Source: https://context7.com/yoke88/psphpipam/llms.txt

Deletes a section from PHPIPAM using its ID. It's important to note that sections containing subnets may require those subnets to be removed first before the section can be deleted. Removal can be done by ID directly or via pipeline.

```powershell
# Remove section by ID
$section = Get-PhpIpamSection -Name "TestSection"
Remove-PhpIpamSection -ID $section.id

# Pipeline removal
Get-PhpIpamSection -Name "OldSection" | Remove-PhpIpamSection

# Returns: $true on success
```
Tokens:
Raw