IP Address Management module root-level workflows


This topic describes the following root-level workflows and their input and output parameters for the IP Address Management module:

Acquire IP Range workflow

The Acquire IP Range workflow creates and reserves a new IP range within an existing network. For an IPv4 or an IPv6 network, use the start address and end address parameters. However, for an IPv6 network, you can also specify ipv6 start prefixipv6 end prefix and ipv6 prefix bits parameters. 

The [expand] macro is a standalone macro and it cannot be used inline.

Acquire IP Range workflow output parameters

Output

Description

status message

Contains a process-specific explanation for the value of success status

Contains the error message in case of failure. 

success status

Provides a process-specific explanation for the value of the success status element

Valid values: success, failure

output

Contains the XML output of a successfully executed workflow

Create Host workflow

The Create Host workflow creates a host within a network. A host resides within a zone.

The [expand] macro is a standalone macro and it cannot be used inline.

Create Host workflow output parameters

Output

Description

status message

A process specific explanation for the value of success status

Contains the error message in case of a failure scenario.

success status

Provides a process-specific explanation for the value of the success status element

Valid values: success, failure

output

Contains the XML output of a successfully executed workflow

Create Network workflow

The Create Network workflow creates a network that contains IP addresses, which you can assign and manage.

The [expand] macro is a standalone macro and it cannot be used inline.

Create Network workflow output parameters

Output

Description

status message

A process specific explanation for the value of success status

Contains the error message in case of a failure scenario.

success status

Provides a process-specific explanation for the value of the success status element

Valid values: success, failure

output

Contains the XML output of a successfully executed workflow

Delete Network workflow

The Delete Network workflow deletes an entire network and all IP addresses in the network.

The [expand] macro is a standalone macro and it cannot be used inline.

Delete Network workflow output parameters

Output

Description

status message

A process specific explanation for the value of success status

Contains the error message in case of a failure scenario.

success status

Provides a process-specific explanation for the value of the success status element

Valid values: success, failure

output

Contains the XML output of a successfully executed workflow

Release IP Range workflow

The Release IP Range workflow frees the range of IP addresses that you specify, making them available in the network.

The [expand] macro is a standalone macro and it cannot be used inline.

Release IP Range workflow output parameters

Output

Description

status message

A process specific explanation for the value of success status

Contains the error message in case of a failure scenario.

success status

Provides a process-specific explanation for the value of the success status element

Valid values: success, failure

output

Contains the XML output of a successfully executed workflow

Release Network Object workflow

A network object can be a single IP address or an entire network. When you release the network object, its status changes from used to unused. If you do not specify an IP address, the entire network that contains all the IP addresses is released.

The [expand] macro is a standalone macro and it cannot be used inline.

Release Network Object workflow output parameters

Output

Description

status message

A process specific explanation for the value of success status

Contains the error message in case of a failure scenario.

success status

Provides a process-specific explanation for the value of the success status element

Valid values: success, failure

output

Contains the XML output of a successfully executed workflow

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*