Browse Source

Remove SNMP APIs from user doc

Deleted APIs for SNMP Communities and Trap Destinations.
Added pointers to Fault Management guide.

Story: 2008132
Task: 41396

Change-Id: Ic2c52bf1b11d1793d57c78264e757795af1deff3
Signed-off-by: MCamp859 <maryx.camp@intel.com>
changes/24/772124/5
MCamp859 8 months ago
parent
commit
012f5b82ee
  1. 540
      api-ref/source/api-ref-sysinv-v1-config.rst

540
api-ref/source/api-ref-sysinv-v1-config.rst

@ -4846,548 +4846,20 @@ badMediaType (415)
SNMP Communities
-----------------
****************************
Lists all SNMP Communities
****************************
.. rest_method:: GET /v1/icommunity
**Normal response codes**
200
**Error response codes**
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
itemNotFound (404)
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"icommunity (Optional)", "plain", "xsd:list", "The list of SNMP Communities."
"access (Optional)", "plain", "xsd:string", "The SNMP GET/SET access control for a specific community."
"community (Optional)", "plain", "xsd:string", "The community string of which the SNMP client is a member."
"view (Optional)", "plain", "xsd:string", "The SNMP MIB view of which the community has access to."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
{
"icommunity": [
{
"access": "ro",
"uuid": "744cddaa-8a24-4573-aa0e-4f8b535d95b7",
"community": "new",
"view": ".1"
},
{
"access": "ro",
"uuid": "73706882-9d7c-4a8f-9409-185ffee0066c",
"community": "guest",
"view": ".1"
}
]
}
This operation does not accept a request body.
***************************************************
Shows information about a specific SNMP Community
***************************************************
.. rest_method:: GET /v1/icommunity/​{community_id}​
**Normal response codes**
200
**Error response codes**
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
itemNotFound (404)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"community_id", "URI", "xsd:string", "The unique community string of an existing SNMP Community."
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"access (Optional)", "plain", "xsd:string", "The SNMP GET/SET access control for a specific community."
"community (Optional)", "plain", "xsd:string", "The community string of which the SNMP client is a member."
"view (Optional)", "plain", "xsd:string", "The SNMP MIB view of which the community has access to."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
{
"uuid": "73706882-9d7c-4a8f-9409-185ffee0066c",
"created_at": "2014-09-24T20:06:54.386982+00:00",
"updated_at": null,
"community": "guest",
"access": "ro",
"view": ".1"
}
This operation does not accept a request body.
**************************
Creates a SNMP Community
**************************
.. rest_method:: POST /v1/icommunity
**Normal response codes**
200
**Error response codes**
badMediaType (415)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"community (Optional)", "plain", "xsd:string", "This parameter specifies the community string to create."
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"access (Optional)", "plain", "xsd:string", "The SNMP GET/SET access control for a specific community."
"community (Optional)", "plain", "xsd:string", "The community string of which the SNMP client is a member."
"view (Optional)", "plain", "xsd:string", "The SNMP MIB view of which the community has access to."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
{
"community": "guest"
}
::
{
"uuid": "73706882-9d7c-4a8f-9409-185ffee0066c",
"created_at": "2014-09-24T20:06:54.386982+00:00",
"updated_at": null,
"community": "guest",
"access": "ro",
"view": ".1"
}
************************************
Modifies a specific SNMP Community
************************************
.. rest_method:: PATCH /v1/icommunity/​{community_id}​
**Normal response codes**
200
**Error response codes**
badMediaType (415)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"community_id", "URI", "xsd:string", "The unique community string of an existing SNMP Community."
"community (Optional)", "plain", "xsd:string", "This parameter specifies the new community string."
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"access (Optional)", "plain", "xsd:string", "The SNMP GET/SET access control for a specific community."
"community (Optional)", "plain", "xsd:string", "The community string of which the SNMP client is a member."
"view (Optional)", "plain", "xsd:string", "The SNMP MIB view of which the community has access to."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
[
{
"path": "/community",
"value": "wrs",
"op": "replace"
}
]
::
{
"uuid": "744cddaa-8a24-4573-aa0e-4f8b535d95b7",
"created_at": "2014-09-23T15:01:53.187164+00:00",
"updated_at": "2014-09-24T19:46:40.138145+00:00",
"community": "wrs",
"access": "ro",
"view": ".1"
}
***********************************
Deletes a specific SNMP Community
***********************************
.. rest_method:: DELETE /v1/icommunity/​{community_id}​
**Normal response codes**
204
StarlingX supports SNMPv2c and SNMPv3, but it is now configured using Helm
charts.
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"community_id", "URI", "xsd:string", "The unique community string of an existing SNMP Community."
This operation does not accept a request body.
For more information, see the `Fault Management Guide, SNMP overview <https://docs.starlingx.io/fault-mgmt/snmp-overview.html>`_ section.
-----------------------
SNMP Trap Destinations
-----------------------
**********************************
Lists all SNMP Trap Destinations
**********************************
.. rest_method:: GET /v1/itrapdest
**Normal response codes**
200
**Error response codes**
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
itemNotFound (404)
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"itrapdests (Optional)", "plain", "xsd:list", "The list of SNMP Trap Destinations."
"ip_address (Optional)", "plain", "xsd:string", "The IP address of a specific trap destination."
"community (Optional)", "plain", "xsd:string", "The community of which the trap destination is a member."
"type (Optional)", "plain", "xsd:string", "The SNMP version of the trap message for a specific destination."
"port (Optional)", "plain", "xsd:integer", "The port number of which SNMP manager is listening for traps."
"transport (Optional)", "plain", "xsd:string", "The transport protocol used by the trap messages."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
{
"itrapdest": [
{
"uuid": "fc33945c-7aba-4d83-9216-a60db7097a23", "links": [
{
"href": "http://192.168.204.2:6385/v1/itrapdest/fc33945c-7aba-4d83-9216-a60db7097a23",
"rel": "self"
},
{
"href": "http://192.168.204.2:6385/itrapdest/fc33945c-7aba-4d83-9216-a60db7097a23",
"rel": "bookmark"
}
],
"ip_address": "10.10.10.1",
"community": "cgts",
"type": "snmpv2c_trap",
"port": 162, "transport": "udp"
},
{
"uuid": "22f0497c-0a09-41c4-8514-cb5afcbf930d", "links": [
{
"href": "http://192.168.204.2:6385/v1/itrapdest/22f0497c-0a09-41c4-8514-cb5afcbf930d",
"rel": "self"
},
{
"href": "http://192.168.204.2:6385/itrapdest/22f0497c-0a09-41c4-8514-cb5afcbf930d",
"rel": "bookmark"
}
],
"ip_address": "27.134.0.8",
"community": "sprint",
"type": "snmpv2c_trap",
"port": 162,
"transport": "udp"
}
]
}
This operation does not accept a request body.
**********************************************************
Shows information about a specific SNMP Trap Destination
**********************************************************
.. rest_method:: GET /v1/itrapdest/​{ip_address}​
**Normal response codes**
200
**Error response codes**
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
itemNotFound (404)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ip_address", "plain", "xsd:string", "The IP address of a specific trap destination."
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ip_address (Optional)", "plain", "xsd:string", "The IP address of a specific trap destination."
"community (Optional)", "plain", "xsd:string", "The community of which the trap destination is a member."
"type (Optional)", "plain", "xsd:string", "The SNMP version of the trap message for a specific destination."
"port (Optional)", "plain", "xsd:integer", "The port number of which SNMP manager is listening for traps."
"transport (Optional)", "plain", "xsd:string", "The transport protocol used by the trap messages."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
{
"uuid": "22f0497c-0a09-41c4-8514-cb5afcbf930d", "links": [
{
"href": "http://192.168.204.2:6385/v1/itrapdest/22f0497c-0a09-41c4-8514-cb5afcbf930d",
"rel": "self"
},
{
"href": "http://192.168.204.2:6385/itrapdest/22f0497c-0a09-41c4-8514-cb5afcbf930d",
"rel": "bookmark"
}
],
"type": "snmpv2c_trap",
"created_at": "2014-09-24T21:09:02.842231+00:00",
"updated_at": null,
"community": "sprint",
"ip_address": "27.134.0.8",
"port": 162,
"transport": "udp"
}
This operation does not accept a request body.
*********************************
Creates a SNMP Trap Destination
*********************************
.. rest_method:: POST /v1/itrapdest
**Normal response codes**
200
**Error response codes**
badMediaType (415)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ip_address (Optional)", "plain", "xsd:string", "This parameter specifies the IP address of a new trap destination."
"community (Optional)", "plain", "xsd:string", "This parameter specifies the community of which the trap destination is a member."
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ip_address (Optional)", "plain", "xsd:string", "The IP address of a specific trap destination."
"community (Optional)", "plain", "xsd:string", "The community of which the trap destination is a member."
"type (Optional)", "plain", "xsd:string", "The SNMP version of the trap message for a specific destination."
"port (Optional)", "plain", "xsd:integer", "The port number of which SNMP manager is listening for traps."
"transport (Optional)", "plain", "xsd:string", "The transport protocol used by the trap messages."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
{
"ip_address": "27.134.0.8",
"community": "sprint"
}
::
{
"uuid": "22f0497c-0a09-41c4-8514-cb5afcbf930d", "links":
[
{
"href": "http://192.168.204.2:6385/v1/itrapdest/22f0497c-0a09-41c4-8514-cb5afcbf930d",
"rel": "self"
},
{
"href": "http://192.168.204.2:6385/itrapdest/22f0497c-0a09-41c4-8514-cb5afcbf930d",
"rel": "bookmark"
}
],
"type": "snmpv2c_trap",
"created_at": "2014-09-24T21:09:02.842231+00:00",
"updated_at": null,
"community": "sprint",
"ip_address": "27.134.0.8",
"port": 162,
"transport": "udp"
}
*******************************************
Modifies a specific SNMP Trap Destination
*******************************************
.. rest_method:: PATCH /v1/itrapdest/​{trapdest_id}​
**Normal response codes**
200
**Error response codes**
badMediaType (415)
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
StarlingX supports SNMPv2c and SNMPv3, but it is now configured using Helm
charts.
"trapdest_id", "URI", "csapi:UUID", "The unique identifier of an existing SNMP Trap Destination."
"ip_address (Optional)", "plain", "xsd:string", "This parameter specifies the IP address of a specific trap destination."
"community (Optional)", "plain", "xsd:string", "This parameter specifies the community of which the trap destination is a member."
For more information, see the `Fault Management Guide, SNMP overview <https://docs.starlingx.io/fault-mgmt/snmp-overview.html>`_ section.
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"ip_address (Optional)", "plain", "xsd:string", "The IP address of a specific trap destination."
"community (Optional)", "plain", "xsd:string", "The community of which the trap destination is a member."
"type (Optional)", "plain", "xsd:string", "The SNMP version of the trap message for a specific destination."
"port (Optional)", "plain", "xsd:integer", "The port number of which SNMP manager is listening for traps."
"transport (Optional)", "plain", "xsd:string", "The transport protocol used by the trap messages."
"uuid (Optional)", "plain", "csapi:UUID", "The universally unique identifier for this object."
"links (Optional)", "plain", "xsd:list", "For convenience, resources contain links to themselves. This allows a client to easily obtain rather than construct resource URIs. The following types of link relations are associated with resources: a self link containing a versioned link to the resource, and a bookmark link containing a permanent link to a resource that is appropriate for long term storage."
"created_at (Optional)", "plain", "xsd:dateTime", "The time when the object was created."
"updated_at (Optional)", "plain", "xsd:dateTime", "The time when the object was last updated."
::
[
{
"path": "/ip_address",
"value": "47.10.1.128",
"op": "replace"
},
{
"path": "/community",
"value": "sprint",
"op": "replace"
}
]
::
{
"uuid": "22f0497c-0a09-41c4-8514-cb5afcbf930d", "links": [
{
"href": "http://192.168.204.2:6385/v1/itrapdest/22f0497c-0a09-41c4-8514-cb5afcbf930d",
"rel": "self"
},
{
"href": "http://192.168.204.2:6385/itrapdest/22f0497c-0a09-41c4-8514-cb5afcbf930d",
"rel": "bookmark"
}
],
"type": "snmpv2c_trap",
"created_at": "2014-09-24T21:09:02.842231+00:00",
"updated_at": "2014-09-24T21:13:51.061300+00:00",
"community": "sprint",
"ip_address": "47.10.1.128",
"port": 162,
"transport": "udp"
}
******************************************
Deletes a specific SNMP Trap Destination
******************************************
.. rest_method:: DELETE /v1/itrapdest/​{trapdest_id}​
**Normal response codes**
204
**Request parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"trapdest_id", "URI", "csapi:UUID", "The unique identifier of an existing SNMP Trap Destination."
This operation does not accept a request body.
--------
Devices

Loading…
Cancel
Save