Jump to

• Request
• Response
• Examples

Get All Plug-ins

get

/rest/{versionId}/admin/plugins

Use this (GET) method to display all plug-ins that exist on the SDM server. You can use query parameters with this task to retrieve a specific type of plugin. On the navigation pane, go to Get Started > Send Requests on the navigation pane. On the Send Requests page, scroll to the Pagination Parameters section for more information.

Request

Path Parameters

• versionId: string

Query Parameters

• ascending(optional): string
• limitation(optional): string
• offset(optional): string
• sort(optional): string
• status(optional): string
• type(optional): string
• vendor(optional): string
• version(optional): string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : pluginInfos

Type: object

Show Source

• pageInfo(optional): object PageInfo
• pluginInfos(optional): array pluginInfo

{
    "properties":{
        "pageInfo":{
            "$ref":"#/definitions/PageInfo"
        },
        "pluginInfos":{
            "items":{
                "$ref":"#/definitions/RestPluginInfo",
                "xml":{
                    "name":"pluginInfo"
                }
            },
            "type":"array",
            "xml":{
                "name":"pluginInfo"
            }
        }
    },
    "type":"object",
    "xml":{
        "name":"pluginInfos"
    }
}

Nested Schema : PageInfo

Type: object

Show Source

• limitation(optional): integer(int32)
• numberOfElements(optional): integer(int64)
• offset(optional): integer(int32)

{
    "properties":{
        "limitation":{
            "format":"int32",
            "type":"integer"
        },
        "numberOfElements":{
            "format":"int64",
            "type":"integer"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : pluginInfo

Type: array

Show Source

• Array of: object pluginInfo

{
    "items":{
        "$ref":"#/definitions/RestPluginInfo",
        "xml":{
            "name":"pluginInfo"
        }
    },
    "type":"array",
    "xml":{
        "name":"pluginInfo"
    }
}

Nested Schema : pluginInfo

Type: object

Show Source

• clusterMembers(optional): array pluginClusterMembers
• description(optional): string
• emPluginAPIVersion(optional): string
• id(optional): string
• name(optional): string
• packageName(optional): string
• previousVersion(optional): string
• product(optional): string
• restPrefixName(optional): string
• type(optional): string
• vendor(optional): string
• version(optional): string

{
    "properties":{
        "clusterMembers":{
            "items":{
                "$ref":"#/definitions/RestPluginClusterMember",
                "xml":{
                    "name":"pluginClusterMember"
                }
            },
            "type":"array",
            "xml":{
                "name":"pluginClusterMembers",
                "wrapped":true
            }
        },
        "description":{
            "type":"string"
        },
        "emPluginAPIVersion":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "packageName":{
            "type":"string"
        },
        "previousVersion":{
            "type":"string"
        },
        "product":{
            "type":"string"
        },
        "restPrefixName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "vendor":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"pluginInfo"
    }
}

Nested Schema : pluginClusterMembers

Type: array

Show Source

• Array of: object pluginClusterMember

{
    "items":{
        "$ref":"#/definitions/RestPluginClusterMember",
        "xml":{
            "name":"pluginClusterMember"
        }
    },
    "type":"array",
    "xml":{
        "name":"pluginClusterMembers",
        "wrapped":true
    }
}

Nested Schema : pluginClusterMember

Type: object

Show Source

• clusterMemberStatus(optional): string
• ipAddress(optional): string
• lastModifiedDate(optional): string
• pluginStatus(optional): string
• uploadedDate(optional): string

{
    "properties":{
        "clusterMemberStatus":{
            "type":"string"
        },
        "ipAddress":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string"
        },
        "pluginStatus":{
            "type":"string"
        },
        "uploadedDate":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"pluginClusterMember"
    }
}

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 get all plug-ins by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

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

Example of Accessing the API with Python

The following example shows how to get all plug-ins by submitting a GET 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
url = "https://example.com:8443/rest/v1.3/admin/plugins"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Thu, 25 Apr 2019 10:55:45 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
vary: Origin,Accept-Encoding
Content-Length: 1393
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"?>
<pluginInfos>
  <pageInfo>
    <limitation>50</limitation>
    <numberOfElements>2</numberOfElements>
    <offset>1</offset>
  </pageInfo>
  <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/>
    <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>
  <pluginInfo>
    <pluginClusterMembers>
      <pluginClusterMember>
        <clusterMemberStatus>ACTIVE</clusterMemberStatus>
        <ipAddress>10.0.0.55</ipAddress>
        <lastModifiedDate>2019-04-25 06:55:04</lastModifiedDate>
        <pluginStatus>INSTALLED</pluginStatus>
        <uploadedDate>2019-04-25 06:52:34</uploadedDate>
      </pluginClusterMember>
    </pluginClusterMembers>
    <description/>
    <emPluginAPIVersion>2B18.3</emPluginAPIVersion>
    <id>ID2</id>
    <name>Enterprise Utilities</name>
    <packageName>ent_utilities2.2_Package.zip</packageName>
    <product>ISR/EOM</product>
    <type>EMS</type>
    <vendor>Oracle</vendor>
    <version>2.2</version>
  </pluginInfo>
</pluginInfos>

Back to Top