Search Nomad documentation » The /plugin endpoints are used to query for and interact with
dynamic plugins. Currently only Container Storage Interface (CSI)
plugins are dynamic.
» This endpoint lists all dynamic plugins.
Method Path Produces GET/v1/pluginsapplication/json
The table below shows this endpoint's support for
blocking queries and
required ACLs .
Blocking Queries ACL Required YESnamespace:csi-list-plugin
» type(string: "")- Specifies the type of plugin to
query. Currently only supports csi. This is specified as a query
string parameter. Returns an empty list if omitted.» $ curl \ https://localhost:4646/v1/plugins?type= csi $ curl \ https://localhost:4646/v1/plugins?type= csi » [
{
"ID" : "example" ,
"Provider" : "aws.ebs" ,
"ControllerRequired" : true ,
"ControllersHealthy" : 2 ,
"ControllersExpected" : 3 ,
"NodesHealthy" : 14 ,
"NodesExpected" : 16 ,
"CreateIndex" : 52 ,
"ModifyIndex" : 93
}
]
[ { "ID" : "example" , "Provider" : "aws.ebs" , "ControllerRequired" : true , "ControllersHealthy" : 2 , "ControllersExpected" : 3 , "NodesHealthy" : 14 , "NodesExpected" : 16 , "CreateIndex" : 52 , "ModifyIndex" : 93 } ] » Get details of a single plugin, including information about the
plugin's job and client fingerprint data.
Method Path Produces GET/v1/plugin/csi/:plugin_idapplication/json
The table below shows this endpoint's support for
blocking queries and
required ACLs .
Blocking Queries ACL Required YESnamespace:csi-read-plugin
» $ curl \ https://localhost:4646/v1/plugin/csi/example_plugin_id $ curl \ https://localhost:4646/v1/plugin/csi/example_plugin_id » [
{
"ID" : "example_plugin_id" ,
"Provider" : "aws.ebs" ,
"Version" : "1.0.1" ,
"ControllersRequired" : true ,
"ControllersHealthy" : 1 ,
"Controllers" : {
"example_node_id" : {
"PluginID" : "example_plugin_id" ,
"Provider" : "aws.ebs" ,
"ProviderVersion" : "1.0.1" ,
"AllocID" : "alloc-id" ,
"Healthy" : true ,
"HealthDescription" : "healthy" ,
"UpdateTime" : "2020-01-31T00:00:00.000Z" ,
"RequiresControllerPlugin" : true ,
"RequiresTopologies" : true ,
"ControllerInfo" : {
"SupportsReadOnlyAttach" : true ,
"SupportsAttachDetach" : true ,
"SupportsListVolumes" : true ,
"SupportsListVolumesAttachedNodes" : false
}
}
} ,
"NodesHealthy" : 1 ,
"Nodes" : {
"example_node_id" : {
"PluginID" : "example_plugin_id" ,
"Provider" : "aws.ebs" ,
"ProviderVersion" : "1.0.1" ,
"AllocID" : "alloc-id" ,
"Healthy" : true ,
"HealthDescription" : "healthy" ,
"UpdateTime" : "2020-01-30T00:00:00.000Z" ,
"RequiresControllerPlugin" : true ,
"RequiresTopologies" : true ,
"NodeInfo" : {
"ID" : "example_node_id" ,
"MaxVolumes" : 51 ,
"AccessibleTopology" : {
"key" : "val2"
} ,
"RequiresNodeStageVolume" : true
}
}
}
}
]
[ { "ID" : "example_plugin_id" , "Provider" : "aws.ebs" , "Version" : "1.0.1" , "ControllersRequired" : true , "ControllersHealthy" : 1 , "Controllers" : { "example_node_id" : { "PluginID" : "example_plugin_id" , "Provider" : "aws.ebs" , "ProviderVersion" : "1.0.1" , "AllocID" : "alloc-id" , "Healthy" : true , "HealthDescription" : "healthy" , "UpdateTime" : "2020-01-31T00:00:00.000Z" , "RequiresControllerPlugin" : true , "RequiresTopologies" : true , "ControllerInfo" : { "SupportsReadOnlyAttach" : true , "SupportsAttachDetach" : true , "SupportsListVolumes" : true , "SupportsListVolumesAttachedNodes" : false } } } , "NodesHealthy" : 1 , "Nodes" : { "example_node_id" : { "PluginID" : "example_plugin_id" , "Provider" : "aws.ebs" , "ProviderVersion" : "1.0.1" , "AllocID" : "alloc-id" , "Healthy" : true , "HealthDescription" : "healthy" , "UpdateTime" : "2020-01-30T00:00:00.000Z" , "RequiresControllerPlugin" : true , "RequiresTopologies" : true , "NodeInfo" : { "ID" : "example_node_id" , "MaxVolumes" : 51 , "AccessibleTopology" : { "key" : "val2" } , "RequiresNodeStageVolume" : true } } } } ] 