Ipam 1.0.0
- 02 Apr 2025
- 3 Minutes to read
- DarkLight
- PDF
Ipam 1.0.0
- Updated on 02 Apr 2025
- 3 Minutes to read
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Ipam - 1.0.0
tags: Python | Enrichment | IPAM | OpenWISP | Subnet | Internal IP
Table of Contents
Description
Integration with OpenWISP IPAM supports CDC users by providing enrichments for internal IPs via REST API. This enables CDC users to make informed decisions regarding incident response.
OpenWISP IPAM is the IP address space administration module of OpenWISP.
CyberProof provides CLI commands to cater to different user actions such as
• Create IP, Enrich IP, Update IP, Delete IP
• Create subnet, Create subnet through csv
• Enrich host, Enrich subnet
• Create Organization, Delete Organization, Get Organization List
CyberProof has also provided custom input adaptive card form for IP, Subnet, Organization operations so that a CDC user can perform these actions on IPAM to get the required information on CDC. Custom adaptive cards are extensively used to display the enriched information on CDC.
| Integration Type: | Enrichment |
| Information read: | IP, Subnet, Organization details |
| API Supported: | Rest APIs |
| Input: | Details required to Create, Enrich, Update, Delete IP or Subnet or Organization |
| Output: | Details enriched information about IP, Subnet, Organization provided in Input |
CDC Command Lines
* **create_ip_cli**
create ip address
| Option | Type | Description | Required |
|---|---|---|---|
| ip | string | ip address ipv4 or ipv6 | True |
| subnet | string | subnet where ip needs | True |
| internet_facing | boolean | internet facing. | False |
| host_name | string | ip address name. | False |
| description | string | ip address description. | False |
| critical_asset | string | critical asset can be in range 1-5. | False |
* **create_subnet_cli**
create subnet address
| Option | Type | Description | Required |
|---|---|---|---|
| subnet | string | text file to upload for adding subnet | True |
| subnet_name | string | name of the subnet | True |
| description | string | description of the subnet | False |
* **import_subnet_cli**
This Command line interface of CDC is used to upload file from CDC to ipam client server. Important point to note :- 1. Atleast one of use case config or rule config file name needs to be mentioned. 2. Input Files for this CLI shall be mandatorily in ".csv" format only. 3. Input 'overwrite' must be a boolean value (true/false). 4. While running the CLI please enter Incident ID or Channel ID or Alert ID ( in CDC version < 2.2 )
| Option | Type | Description | Required |
|---|---|---|---|
| subnet_file | string | subnet import file name | False |
* **ip_operation_form_cli**
Populates form to handle IP operation
| Option | Type | Description | Required |
|---|
* **subnet_operation_form_cli**
Populates form to handle subnet operation
| Option | Type | Description | Required |
|---|
* **update_ip_cli**
update ip address
| Option | Type | Description | Required |
|---|---|---|---|
| ip | string | ip address. | True |
| host_name | string | ip address name. | False |
| description | string | ip address description. | False |
| internet_facing | boolean | internet facing. | False |
| critical_asset | string | critical asset can be in range 1-5. | False |
* **update_subnet_cli**
update subnet address
| Option | Type | Description | Required |
|---|---|---|---|
| subnet | string | text file to upload for adding subnet | True |
| subnet_name | string | name of the subnet | True |
| description | string | description of the subnet | False |
* **create_organization_cli**
create organization in ipam server
| Option | Type | Description | Required |
|---|---|---|---|
| name | string | name of organization , make sure its unique | True |
| string | email to assign to organization. | True | |
| description | string | description of organization | True |
* **delete_ip_cli**
delete ip address
| Option | Type | Description | Required |
|---|---|---|---|
| ip | string | ip address ipv4 or ipv6 | True |
* **delete_organization_cli**
delete organization from ipam server
| Option | Type | Description | Required |
|---|---|---|---|
| organization_name | string | name of organization , make sure its unique | True |
* **delete_subnet_cli**
delete subnet address
| Option | Type | Description | Required |
|---|---|---|---|
| subnet | string | subnet from ipam | True |
* **enrich_host_cli**
fetch host details
| Option | Type | Description | Required |
|---|---|---|---|
| host_name | string | ip address ipv4 or ipv6 | True |
* **enrich_ip_cli**
fetch ip address details
| Option | Type | Description | Required |
|---|---|---|---|
| ip | string | ip address ipv4 or ipv6 | True |
* **enrich_subnet_cli**
enrich subnet details
| Option | Type | Description | Required |
|---|---|---|---|
| subnet | string | subnet | True |
* **get_organizations_cli**
fetch organization list
| Option | Type | Description | Required |
|---|
* **get_subnetlist_cli**
get subnet list
| Option | Type | Description | Required |
|---|
Workflows
* **get_file_content_subworkflow**
This workflow is used to get the content of the yaml file attached to a CDC incident, alert, or channel.
* **post_create_organization**
Post create-organization in CDC by ID of incident/message/chanel.
* **post_delete_ip**
Post delete-ip in CDC by ID of incident/message/chanel.
* **post_delete_organization**
Post delete-organization in CDC by ID of incident/message/chanel.
* **post_delete_subnet**
Post delete-subnet in CDC by ID of incident/message/chanel.
* **post_enrich_host**
Post enrich-host in CDC by ID of incident/message/chanel.
* **post_enrich_ip**
Post enrich-ip in CDC by ID of incident/message/chanel.
* **post_enrich_subnet**
Post enrich-subnet in CDC by ID of incident/message/chanel.
* **post_get_organizations**
Post get-organizations in CDC by ID of incident/message/chanel.
* **post_get_subnetlist**
Post get-subnetlist in CDC by ID of incident/message/chanel.
Rules
No rules
Sensors
No sensors
Triggers
No triggers
Known Issues
Was this article helpful?