Integration Guides › Web Service API Reference Guide › Valid Web API Objects › iface Object › enable Method (iface Object)

enable Method (iface Object)

Description

Enable a terminal interface on a component

Syntax

/api/v1/iface/enable?app=application&comp=component&iface=interface&vdc=controller-name 

Arguments

app

Name of the application

comp

Name of the component

iface

Name of the interface

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Enable external interface for test:main.LUX5.

GET http://192.168.123.200/api/v1/iface/enable?app=test&comp=main.LUX5&iface=external&vdc=mygrid 

Sample Output

XML:

<opt></opt>

JSON:

{} 

HTTP Error Codes

404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

400.4

Missing required arguments (app). - Argument app=app missing in the request.

400.4

Missing required arguments (comp). - Argument comp=comp missing in the request.

400.4

Missing required arguments (iface). - Argument iface=iface missing in the request.

404.1

Failed to enable interface test:main.srv.in because it doesn't exist. - Invalid interface, application or component specified in the request or application/component is not running.