IPAM

To learn more about this OneFuse module, refer to IPAM.

Prerequisites

1. Configure OneFuse Property Set(s) and OneFuse Module Policies.
2. Run OneFuse Configuration per Cloud Assembly Organization.
3. Review an overview on OneFuse Modules with Aria Automation 8.1+/Cloud.
4. Create a new Cloud Template (if none exist) or determine which existing Cloud Template(s) will utilize this OneFuse Module.
   • Resource: Designing your vRealize Automation Cloud Assembly deployments

Steps

1. Know the name of the OneFuse Endpoint created via OneFuse Configuration.
2. Determine which OneFuse IPAM Policies to run for this Cloud Template.
3. Update the Cloud Template to add in the necessary vRA Properties and/or add in the Custom Resource to invoke a OneFuse IPAM Policy.
4. Deploy the Cloud Template to provision a vRA Deployment and reserve IP Address(es).
5. Destroy the vRA Deployment to remove the IP Address(es) for the destroyed resource(s).

Update the Cloud Template

1. Log in to vRA > Cloud Assembly
2. Select the Design tab from the top menu bar
3. Select the Cloud Templates tab from the left menu
4. Edit the Cloud Template and perform the below:

Option 1: Add in necessary vRA Property

The following vRA Property needs to be added to the Cloud Template’s Code section under the Resource(s) of interest.

Example YAML:

# Execute OneFuse IPAM Policy

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <IPAM Policy Name> is prod

name: Simple Example
resources:
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: CentOS7
      flavor: small
      count: 1
      OneFuse_IpamPolicy_Nic0: 'onefuse:prod'

Optional. IPAM Multi-IP Support:

Support for multiple IP Addresses on a single interface. The IP Addresses are reserved and stored in both OneFuse and vRA Machine Properties for future reference in vRA lifecycles.

• Replace <niclabel> with a value that is appended to the hostname.
• Default behavior appends <niclabel> to the hostname after a hyphen (-). To override, modify the Hostname Override field on the OneFuse IPAM Policy.
• Without Additional Naming Property: default behavior of the <niclabel> is to get appended to the hostname after a hyphen (-). To override this behavior, modify the field Hostname Override on the OneFuse IPAM Policy.
• With Additional Naming Property: if an Additional Naming Policy is defined that matches this value, the name generated from the Naming Policy will be used.

Example YAML:

# -- Property Name
# <niclabel> is xyz

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <OneFuse IPAM Policy Name> is prod

# Example
OneFuse_IpamPolicy_AdditionalTrigger: 'true'
OneFuse_IpamPolicy_Additional_xyz: 'onefuse:prod'

Additional helpful vRA properties

• The first OneFuse Module Policy execution will populate this property and pass it into other OneFuse Modules automatically.
• When a Tracking ID is not provided, one is generated for the Policy execution.

• Replace <#> with a number from 0 to 9, one for each NIC. For most use cases, NIC 0 is the primary network interface.
• Replace <value> with an appropriate key: dnsSuffix, fqdn, gateway, hostname, ipAddress, macAddress, netmask, network, subnet, target
• target will be the FQDN when a DNS Suffix is provided; otherwise, it will be the hostname without domain.

Example Cloud Template YAML

# Execute OneFuse IPAM Policy

# -- Property Value
# <OneFuse Endpoint Name>  is onefuse
# <IPAM Policy Name> is prod

name: Simple Example
resources:
  Cloud_Machine_1:
    type: Cloud.Machine
    properties:
      image: CentOS7
      flavor: small
      count: 1
      OneFuse_IpamPolicy_Nic0: 'onefuse:prod'

Option 2: Add in Custom Resource for OneFuse IPAM

• From the Resource Types navigation and expand Custom Resources
• Drag-and-drop OneFuse:IPAM_v1 to the canvas
• In the Code tab, provide values for the following properties:

IPAM specific parameters:

Provision

Deploy a Cloud Template with OneFuse IPAM Policies configured. IP Address(es) will get reserved in the desired IPAM Provider.

Outputs

The following vRA Properties will exist on the Deployment.

Deprovision

Destroy an existing deployment with OneFuse IPAM Policies configured. The IP Address(es) will be removed from the desired IPAM Provider.

vRA EBS

Troubleshooting

Troubleshoot in vRealize Orchestrator.

1. Log in to vRealize Orchestrator.
2. Turn on Verbose Logging and try again to see additional log messages in vRO Workflows:
   1. Select Library > Workflows from the left menu
   2. Go to: OneFuse > IPAM > vRA8 to find corresponding workflow runs and view logs
   3. Optionally, run the workflows in the Manual folder to manually test
3. Optionally, configure timeouts for EBS and/or Configure timeouts for OneFuse modules.

Additional resources:

• Review Troubleshooting in OneFuse
• Review VMware troubleshooting resources