Page Comparison

Table of Contents

...

We can also manage nodes using the API.

Operation

Method

URL

Response

Example

Get Nodes

GET

http://host/en/omk/admin/api/v2/nodes.json

http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes.json?requestData=undefined&page=1&per_page=25&sort_by=name&order=asc

Get Node

GET

http://host/en/omk/admin/api/v2/nodes/{node_uuid}.json

http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes/86a82b4c-6ef6-4691-8c8c-1fc8da334d6f.json

Create Node

POST

http://host/en/omk/admin/api/v2/nodes.json

The node in json from the recently node created, including the UUID

http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes.json

Code Block
{ "

configuration

activated":
{
"

netType

NMIS": "

default

1",
"

polling_policy

opConfig": "

default

0",
"

port

opEvents": "

161

1"
},
"

collect

configuration":

1,"threshold


{
"active":

1

 null,"

roleType

authkey": "

default

","

ping

authpassword":

1,"group":"NMIS9

 "","

host

authprotocol":

"asgard.opmantek.net","location":

 null,"

customer

businessService": null,
"

businessService

collect":

null

1,"

notes

community": "","

host_backup

context": "","

active

customer": null,"

community

group": "NMIS9",
"

wmiusername

host": "asgard.opmantek.net","

wmipassword

host_backup": "","location": null,
"

username

netType": "default","nettype": null,"node_context_name": "","

authpassword

node_context_url": "","

authkey

notes": "",
"

authprotocol

ping":

null

1,"

privpassword

polling_policy": "default","

privkey

port": "161","

privprotocol

privkey":

null

 "","

serviceStatus

privpassword":

null,

nettype

:null

,
"

roletype

privprotocol": null,"

node

remote_

context

connection_name": "","

node

remote_

context

connection_url": "","

remote_connection_name

roleType": "default",
"

remote_connection_url

roletype": null,"serviceStatus"

}

: null,"

activated

threshold":

{

1,"

opEvents

username": "

1

","

opConfig

wmipassword": "

0

","

NMIS

wmiusername": "

1

"
},

"uuid":null,


"current_user_privileges":
{
"

update

delete": true,
"

delete

update": true
},
"

name

friendly_addresses": "

test

",
"friendly_

addresses

aliases": "",
"

friendly_aliases

name": "test",
"uuid": null
}

Update Node

PUT

http://host/en/omk/admin/api/v2/nodes/{node_uuid}.json

http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes/b56ba595-69e7-4702-9fe5-49512e1340b0.json

Code Block
{ "

configuration

activated":

{"netType


    {
        "NMIS": "

default

1",

"polling_policy


        "opConfig": "

1_minute

0",

"port


        "opEvents": "

161","collect":1,"threshold":1,"roleType":"access","ping":1,"group":"EXSI","active":1,"addresses":[

1"
    },
    "addresses":
    [],
    "aliases":
    [],
    "cluster_id": "a515c63a-0d11-4bcb-a402-39a4600aebb9",
    "configuration":
    {
        "active": 1,
        "addresses":
        [
            "192.168.88.13"
        ],

"aliases":[],


        "aliases":
        [],
        "authkey": "","authpassword": "","authprotocol": "md5","businessService": null,"cbqos": "none",
        "collect": 1,"community": "OMKRead","context": "",

"customer":"Opmantek","depend":[],"display_name":"

"customer": "Opmantek","depend":
        [],
        "display_name": "","group": "EXSI","host": "castor.opmantek.net","host_backup": "","ip_protocol": "IPv4",
        "location": "Cloud","max_msg_size": 1472,"max_repetitions

":0,"model":"automatic"

": 0,"model": "automatic",
        "netType": "default","nettype": null,"node_context_name": "Node Context",
        "node_context_url": "https://somelink.com/map/thing/","

notes":"

notes": "","ping": 1,
        "polling_policy": "1_minute","port": "161","privkey": "","privpassword": "",
        "privprotocol": "des","remote_connection_name": "SSH to Node","remote_connection_url": "ssh://$host",
        "roleType": "access","roletype": null,"serviceStatus": "Testing","services":

[],


        [],
        "sysDescr": "VMware ESXi 6.7.0 build-17167734 VMware, Inc. x86_64","

timezone

threshold":

0

1,"

username

timezone":

"","version":"snmpv2c","webserver":0,"wmipassword":"","wmiusername":"","nettype":null,"roletype":null},"activated":{"opEvents":"1","opConfig":"0","NMIS":"1"},"uuid":"b56ba595-69e7-4702-9fe5-49512e1340b0",

 0,
        "username": "","version": "snmpv2c","webserver": 0,"wmipassword": "","wmiusername": ""
    },
    "current_user_privileges":

{"update":0,


    {
        "delete": 0

},"addresses":[],"aliases":[],"cluster_id":"a515c63a-0d11-4bcb-a402-39a4600aebb9","

,
        "update": 0
    },
    "friendly_addresses": "192.168.88.13",
    "friendly_aliases": "",
    "name": "Castor",
    "node_local": "Remote",
    "overrides":
    {},
    "server_name": "fulla",
    "unknown":
    {},
    "uuid": "b56ba595-69e7-4702-9fe5-49512e1340b0"
}

Delete Node

DELETE

http://host/en/omk/admin/api/v2/nodes/{node_uuid}.json

http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes/b56ba595-69e7-4702-9fe5-49512e1340b0.json

Important: All this methods are authenticated.

Operation

Method

URL

Example

Authenticate

POST

http://host/en/omk/admin/login

http://uburnto.opmantek.net/en/omk/opHA/login

Code Block
{"username": "username", "password": "password"}

...

cluster_id is the uuid of which opHA server the node belongs to.

E.x.

Create Remote

POST

http://host/en/omk/admin/api/v2/nodes.json

http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes.json

Code Block

{"configuration":{"pollers": "a515c63a-0d11-4bcb-a402-39a4600aebb9", "netType":"default","polling_policy":"default","port":"161","collect":1,"threshold":1,"roleType":"default","ping":1,"group":"NMIS9","host":"asgard.opmantek.net","location":null,"customer":null,"businessService":null,"notes":"","host_backup":"","active":null,"community":"","wmiusername":"","wmipassword":"","username":"","context":"","authpassword":"","authkey":"","authprotocol":null,"privpassword":"","privkey":"","privprotocol":null,"serviceStatus":null,"nettype":null,"roletype":null,"node_context_name":"","node_context_url":"","remote_connection_name":"","remote_connection_url":""},"activated":{"opEvents":"1","opConfig":"0","NMIS":"1"},"uuid":null,"current_user_privileges":{"update":true,"delete":true},"name":"test","friendly_addresses":"","friendly_aliases":""}

...

cluster_id is the uuid of which opHA server the node belongs to.

E.x.

Create Remote

PUT

http://host/en/omk/admin/api/v2/nodes/node_uuid.json

http://volla.opmantek.net:6042/en/omk/admin/api/v2/nodes/6ce5fd5c-d703-4d03-b36c-b8e01439a9f2.json

Code Block

{"cluster_id": "a515c63a-0d11-4bcb-a402-39a4600aebb9", "configuration":{"netType":"default","polling_policy":"default","port":"161","collect":1,"threshold":1,"roleType":"default","ping":1,"group":"NMIS9","host":"asgard.opmantek.net","location":null,"customer":null,"businessService":null,"notes":"","host_backup":"","active":null,"community":"","wmiusername":"","wmipassword":"","username":"","context":"","authpassword":"","authkey":"","authprotocol":null,"privpassword":"","privkey":"","privprotocol":null,"serviceStatus":null,"nettype":null,"roletype":null,"node_context_name":"","node_context_url":"","remote_connection_name":"","remote_connection_url":""},"activated":{"opEvents":"1","opConfig":"0","NMIS":"1"},"uuid":null,"current_user_privileges":{"update":true,"delete":true},"name":"test","friendly_addresses":"","friendly_aliases":""}

...

Versions Compared

Old Version 5

New Version 6

Key