Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

ComputeContainer refreshIP request

Description

This API refreshes IP addresses of VMs, in case changed, in BMC Cloud Lifecycle Management. 

This API was added with BMC Cloud Lifecycle Management 3.1 Service Pack 1 Patch 2.

API stability classification

Unassigned

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/ComputeContainer/guid

void

Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common request headers listed in HTTP request and response headers.

Request message body

This API uses the following objects in the request message body JSON. 

Top-level objects

Name

Type

Multi-
plicity

Description

callbackURL

String

0..1

URL to call when the operation finishes

postCallout

String

0..1

Identifier of a callout to run after the operation executes

preCallout

String

0..1

Identifier of a callout to run before the operation executes

timeout

Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

operationParams

OperationParameter

1

Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.


Input parameters to include in operationParams

Name

Type

Multi-
plicity

Description

refreshIP

String0..1

Refreshes IP address

Valid values:

1: Refresh IP address

0: Does not refresh

overrideIPString 0..1

Refreshes IP address even if the compute container is attached to a load balancer or a firewall

Valid values:

0: Does not override

1: Refresh IP address

The following figure describes a sample API request.

{
"operationParams" : [{
"multiplicity" : "0..1",
"name" : "refreshIP",
"value" : 1,
"type" : "java.lang.Integer"
} ,{
"multiplicity" : "0..1",
"name" : "overrideIP",
"value" : 1,
"type" : "java.lang.Integer"
}],
"preCallout" : "",
"postCallout" : "",
"callbackURL" : "",
"alreadyTraversedGlobalRegistry" : false, "alreadyTraversedLocalRegistry" : false, "timeout" : -1 }

HTTP response message

Response message headers

This API uses only common response headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.

Was this page helpful? Yes No Submitting... Thank you

Comments