IPAM
4 minute read
To learn more about this OneFuse module, refer to IPAM.
Prerequisites
- Configure OneFuse Property Set(s) and OneFuse Module Policies.
- Install OneFuse XUI per CloudBolt CMP.
- Review an overview on OneFuse Modules with CloudBolt CMP.
- Create a new Blueprint (if none exist) or determine which existing Blueprint(s) will utilize this OneFuse Module. Resource: Blueprints.
Configure the Blueprint
-
Verify Networks in CMP have certain fields set with values:
-
Log in to CMP and go to Admin > Networks.
-
Find and verify the following fields are set with values for all networks that OneFuse will provide IP Addresses for.
For these networks, it cannot be assigned to another native CMP IPAM integration nor have an active IP Pool.
Field Name Notes Name The Network name specified here must match the OneFuse IPAM Policy Network Name. Gateway This field is required to have a value. Netmask This field is required to have a value. Dns1 This field is optional. If there is a value defined, the OneFuse IPAM Policy will override this value with the one defined on the OneFuse IPAM Policy. Dns2 This field is optional. If there is a value defined, the OneFuse IPAM Policy will override this value with the one defined on the OneFuse IPAM Policy. DNS Domain This field is optional. If there is a value defined, the OneFuse IPAM Policy will override this value with the one defined on the OneFuse IPAM Policy. Addressing schema This field needs to be set to: DHCP only and is required for OneFuse Driven Networks. Poweron stage This field needs to be set to: On VM Creation.
-
-
Know the name of the OneFuse Connection Info created via OneFuse XUI initial setup.
-
Determine which OneFuse IPAM Policies to run for this Blueprint.
-
Update the Blueprint to add in necessary parameters to invoke OneFuse IPAM Policies.
-
Deploy the Blueprint to provision a deployment and reserve IP Address(es).
-
Destroy the Deployment to remove the IP Address(es) for the destroyed resource(s).
Update the Blueprint
- Log in to CloudBolt CMP.
- If not already on the Catalog page, select Catalog from the main menu.
- Search and find the desired CloudBolt Blueprint.
- Edit the Blueprint by selecting the gear icon on the bottom-right of the Catalog Item.
Add in necessary parameters
The following Parameters need to exist on the Blueprint.
Learn more about CloudBolt Parameters for: Blueprints, Environments, and Groups.
Call an IPAM Policy for a specific NIC:
| Parameter name format | Parameter value format |
|---|---|
OneFuse_IpamPolicy_Nic<#>: Replace <#> with a number from 0 to 9, one for each NIC. Default is 0. |
<OneFuse Connection Info Name>:<IPAM Policy Name> |
Example parameter:
OneFuse_IpamPolicy_Nic0: 'OneFuse:MyIpamPolicy'
Additional helpful properties passed to OneFuse module
Purpose: Relate OneFuse Policy executions from different OneFuse Modules together with a Tracking ID.
| Property and Parameter | Value Format |
|---|---|
OneFuse_Tracking_Id |
A GUID (globally unique identifier) that links OneFuse Policy Executions and the resulting Managed Objects together for a given resource on a deployment. The first OneFuse Module Policy execution will populate this Parameter and it will be passed into other OneFuse Modules automatically. Learn more about OneFuse Tracking ID. |
When a Tracking ID is not provided, a Tracking ID gets generated for the Policy execution.
Purpose: Reference a specific NIC’s values to get hostname, IP Address, etc.
| Property Format | Example |
|---|---|
OneFuse_VmNic<#>.<value> |
See examples below |
Replace <#> with a number from 0 to 9, one for each NIC.
Replace <value> with an appropriate key: assignment, dnsServers, dnsSuffix, fqdn, gateway, hostname, ipAddress, label, mac, network, nicLabel, target
For most use cases, NIC 0 is the primary network interface and the target hostname is a Fully Qualified Domain Name (FQDN).
Examples:
OneFuse_VmNic0.dnsSuffixOneFuse_VmNic0.fqdnOneFuse_VmNic0.hostnameOneFuse_VmNic0.ipAddressOneFuse_VmNic0.target: when DNS Suffix is provided, will be the FQDN; otherwise, will be the hostname (without domain).
Purpose: Reference VM hardware information: cpu, memory, etc.
| Property Format | Example |
|---|---|
OneFuse_VmHardware.<value> |
See examples below |
Replace <value> with an appropriate key: cpuCount, memoryGB, memoryMB, platformUuid, powerState, totalStorageGB
Examples:
OneFuse_VmHardware.cpuCountOneFuse_VmHardware.memoryGBOneFuse_VmHardware.platformUuidOneFuse_VmHardware.powerStateOneFuse_VmHardware.totalStorageGB
Provision
Deploy a Blueprint with OneFuse IPAM Policies configured. IP Address(es) will get reserved in the desired IPAM Provider.
Outputs
The following parameter will have the generated OneFuse IPAM Managed Object as a JSON string on the resource.
| Parameter name | Parameter value format |
|---|---|
OneFuse_Ipam_Nic#: where # is a number 0–9 |
JSON string of OneFuse IPAM Managed Object |
Deprovision
Destroy an existing resource with OneFuse IPAM Policies configured. The IP Address(es) will be removed from the desired IPAM Provider.
Trigger points
| Job / Process | Trigger point name | Run sequence | Plugin action name |
|---|---|---|---|
| Provision Server | Pre-Create Resource | 1200 | OneFuse - Provision IPAM |
| Delete Server | Post-Delete | 1400 | OneFuse - De-Provision IPAM |