Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
ContentIndex
  
[+] Expand All
[-] Collapse All

SDG Devices Management RESTful Web Services

The following operations can be performed using the Edge Services Director SDG Devices Management RESTful Web Services.

Get All Unmanaged Devices

This request is used to collect all the unmanaged service delivery gateway (SDG) devices, which are not managed and monitored from the Edge Services Director application.

URI

/api/sgd/sdgmgmt/host-discovery/getAllUnmanagedHosts

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.host-
discovery.getAllUnmanagedHosts+json;version=1;charset=UTF-8

Consumes

None

Produces

Set of unmanaged SDGs

Response Status Code

Message

Description

200 OK

Successful retrieval of the list of unmanaged devices.

204 No Content

Invalid device ID.

Output

Sample XML Output

<response>
<success>false</success>
<totalRows>0</totalRows>
</response>

Mark an SDG Device as Unmanaged

This request is used to change a managed device to be an unmanaged device, which removes the particular SDG from management and provisioning by the Edge Services Director application.

URI

/api/sgd/sdgmgmt/sdgmanagement/unmanageSDG/SDGEntity

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.sdgmgmt.sdgmanagement.
unmanageSDG.SDGEntity+json;version=1;charset=UTF-8

Consumes

None

Produces

Changes a managed device to an unmanaged device

Response Status Code

Message

Description

200 OK

Successful modification of a managed device to be an unmanaged device.

Input

Sample JSON Input

" “

Get All Managed Devices

This request is used to collect all the managed service delivery gateway (SDG) devices, which are administered and provisioned from the Edge Services Director application.

URI

/api/sgd/sdgmgmt/sdgmanagement/discovery-sdgmanagement/root

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.sdgmanagement.
discovery-sdgmanagement.root+json;version=1;charset=UTF-8

Consumes

None

Produces

Set of managed SDGs

Response Status Code

Message

Description

200 OK

Successful retrieval of the list of managed devices.

Output

Sample JSON Output

Mark an SDG Device as Managed

This request is used to change an unmanaged device to be a managed device, which brings the particular SDG under the management and control of the Edge Services Director application.

URI

/api/sgd/sdgmgmt/sdgmanagement/manageSDG/SDGEntity

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.sdgmgmt.sdgmanagement.
manageSDG.SDGEntity+json;version=1;charset=UTF-8

Consumes

None

Produces

Changes a managed device to an unmanaged device

Response Status Code

Message

Description

200 OK

Successful modification of an unmanaged device to be a managed device.

Input

Sample JSON Input

{
   "sdgId":"$sdgId",
   "sdgName":"$v->{SGD_NAME}",
   "kpiTemplate":"SystemDefault",
   "sdgGrpId":"$sdgGroupId",
   "description":"desc"
}

View Service Instances Configuration for an SDG

This request is used to view the configuration settings and attributes related to the different service instances configured on a particular SDG.

URI

/api/sgd/sdgmgmt/view-service/getAllServiceInstances
?moid={SDGHostName}

HTTP Method

GET

Content-Type

application/vnd.net.juniper.space.sdgmgmt.view-
service.etAllServiceInstances
?moid={SDGHostName}+json;version=1;charset=UTF-8

Consumes

None

Produces

Displays the configuration parameters of all services of the specified device

Response Status Code

Message

Description

200 OK

Configuration details are displayed.

Output

Sample XML Output

Modified: 2016-08-02