1. REST API for Session Delivery Manager Release 8.2
  2. Tasks
  3. plugin

Update Plug-in Information

put

/rest/{versionId}/admin/plugins/{pluginId}

Use this (PUT) method to update information about the plug-in.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : pluginInfo
Type: object
Show Source
Nested Schema : pluginClusterMembers
Type: array
Show Source
Nested Schema : pluginClusterMember
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : pluginInfo
Type: object
Show Source
Nested Schema : pluginClusterMembers
Type: array
Show Source
Nested Schema : pluginClusterMember
Type: object
Show Source

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

403 Response

There is no permission to access the resources.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

500 Response

Internal server error
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to update plug-in information by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PUT -b sessionid.txt \
    -d@request.xml \
    --header "Accept: application/xml" \
    --header "Content-Type: application/xml" \
    "https://example.com:8443/rest/v1.3/admin/plugins/ID1"

The following shows an example of the contents of the request.xml file sent as the request body. 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pluginInfo>
  <pluginClusterMembers>
    <pluginClusterMember>
      <clusterMemberStatus>ACTIVE</clusterMemberStatus>
      <ipAddress>10.0.0.55</ipAddress>
      <pluginStatus>INSTALLED</pluginStatus>
    </pluginClusterMember>
  </pluginClusterMembers>
  <description>Oracle Communications SDM plugin</description>
  <emPluginAPIVersion>2B18.3</emPluginAPIVersion>
  <id>ID1</id>
  <name>Enterprise Edge &amp; Core</name>
  <packageName>ent_edge_core2.2_Package.zip</packageName>
  <product>ESBC/ECB</product>
  <type>EMS</type>
  <vendor>Oracle</vendor>
  <version>2.2</version>
</pluginInfo>

Example of Accessing the API with Python

The following example shows how to update plug-in information by submitting a PUT request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate. 

import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/admin/plugins/ID1"
headers = { "Accept":"application/xml", "Content-Type":"application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.xml"))
resp = requests.put(url, headers=headers, data=data)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 08 May 2019 12:13:32 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
vary: Origin,Accept-Encoding
Content-Length: 694
Content-Type: application/xml

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<pluginInfo>
  <pluginClusterMembers>
    <pluginClusterMember>
      <clusterMemberStatus>ACTIVE</clusterMemberStatus>
      <ipAddress>10.0.0.55</ipAddress>
      <lastModifiedDate>2019-04-25 06:55:19</lastModifiedDate>
      <pluginStatus>INSTALLED</pluginStatus>
      <uploadedDate>2019-04-25 06:52:20</uploadedDate>
    </pluginClusterMember>
  </pluginClusterMembers>
  <description>Oracle Communications SDM plugin</description>
  <emPluginAPIVersion>2B18.3</emPluginAPIVersion>
  <id>ID1</id>
  <name>Enterprise Edge &amp; Core</name>
  <packageName>ent_edge_core2.2_Package.zip</packageName>
  <product>ESBC/ECB</product>
  <type>EMS</type>
  <vendor>Oracle</vendor>
  <version>2.2</version>
</pluginInfo>
Back to Top