...
| Codeblock |
|---|
|
{
"method":"feed.virtual_device.read",
"params":{
"apikey":"24174j3tqj",
"filter": {
"host_name": "cisco"
},
"limit": 50
},
"version":"2.0",
"id": 1
} |
...
| Parameter | Typ | Beschreibung | Version |
|---|
| filter | array | Optional: Kriterien, nach denen gefiltert werden soll. Als Eigenschaften können hier alle vorhandenen Feldnamen genutzt werden (siehe feed.virtual_device.get_fields). | ab Version 1.0 |
| limit | int | Optional: Begrenzt die Anzahl der Ergebnisse (Maximalwert 9999) | ab Version 1.0 |
| offset | int | Optional: Angabe, ab welcher Anzahl von Ergebnissen begonnen werden soll | ab Version 1.0 |
Rückgabewert
Eigenschaften einer Jira Konfigurationvirtuellen Gerätes.
| Wert | Typ | Beschreibung | Version |
|---|
| isys_id | int | Interne ID | ab Version 1.0 |
| isys_user_name | string | Nutzername | ab Version 1.0 |
| isys_mac_address | string | MAC-Adresse | ab Version 1.0 |
| isys_host_name | string | Hostname | ab Version 1.0 |
| isys_ip_address | string | IP-Adresse des Endgerätes | ab Version 1.0 |
| isys_subnet | string | Adresse des Subnetz | ab Version 1.0 |
| isys_device_name | string | Gerätename des Switches | ab Version 1.0 |
| isys_device | string | IP-Adresse des Switches | ab Version 1.0 |
| isys_port | string | Portbezeichnung | ab Version 1.0 |
| isys_port_name | string | Beschreibung des Ports | ab Version 1.0 |
| isys_port_state | string | Art des Ports | ab Version 1.0 |
| isys_vtp_domain | string | Name der VTP-Domain | ab Version 1.0 |
| isys_vlan | string | Bezeichnung des VLAN | ab Version 1.0 |
| isys_vlan_type | string | Typ des VLAN | ab Version 1.0 |
| isys_last_seen | string | Zeitpunkt wann das Gerät zuletzt erkannt wurde | ab Version 1.0 |
| isys_notes | string | Bemerkungen | ab Version 1.0 |
| isys__id | int | Interne ID | ab Version 1.0 |
...
feed.virtual_device.get_fields
Beschreibung
Legt eine neue Jira Konfiguration anGibt alle verfügbaren Feldnamen zurück.
Beispielaufruf
| Codeblock |
|---|
|
{
"method":"feed.virtual_device.get_fields",
"params":{
"apikey":"24174j3tqj"
},
"version":"2.0",
"id": 1
} |
Parameter
keine
Rückgabewert
Auflistung aller verfügbarer Feldnamen.
...
feed.virtual_device.create
Beschreibung
Legt eine neue Jira Konfiguration ein neues virtuelles Gerät an.
Beispielaufruf
| Codeblock |
|---|
|
{
"method":"feed.virtual_device.create",
"params":{
"apikey":"24174j3tqj",
"data": {
"mac_address":"http://jira.domain:800000-01-da-f1-3d-2e",
"namelast_seen":"myJira2021-04-19T10:15:32",
"usernamehost_name":"adminHorst01",
"passwordnotes":"pa$$w0rdThis is a new device"
}
},
"version":"2.0",
"id": 1
} |
...
| Parameter | Typ | Beschreibung | Version |
|---|
| mac_address | string | Vollständige URL zur Jira-InstanzMAC-Adresse | ab Version 1.0 |
| last_seen | string | Zeitpunkt wann das Gerät zuletzt erkannt wurde | ab Version 1.0 |
| user_name | string | Optional: Nutzername | ab Version 1.0 |
| host_name | string | Name der Jira-InstanzOptional: Hostname | ab Version 1.0 |
| ip_address | string | Optional: IP-Adresse des Endgerätes | ab Version 1.0 |
| subnet | string | Optional: Adresse des Subnetz | ab Version 1.0 |
| device_name | string | Optional: Gerätename des Switches | ab Version 1.0 |
username| device | string | Optional: | Benutzername der Jira-InstanzIP-Adresse des Switches | ab Version 1.0 |
| port | string | Optional: Portbezeichnung | ab Version 1.0 |
| port_name | string | Optional: Beschreibung des Ports | ab Version 1.0 |
| port_state | string | Optional: Art des Ports | ab Version 1.0 |
| passwordvtp_domain | string | Optional: Passwort Name der Jira-InstanzVTP-Domain | ab Version 1.0 |
| vlan | string | Optional: Bezeichnung des VLAN | ab Version 1.0 |
| vlan_type | string | Optional: Typ des VLAN | ab Version 1.0 |
| notes | string | Optional: Bemerkungen | ab Version 1.0 |
Rückgabewert
...
Beschreibung
Aktualisiert eine bestehende Jira Konfigurationbestehendes virtuelles Gerät.
Beispielaufruf
| Codeblock |
|---|
|
{
"method":"feed.virtual_device.update",
"params":{
"apikey":"24174j3tqj",
"idmac_address":4"00-01-da-f1-3d-2e",
"data": {
"last_seen":"2021-04-19T10:15:32",
"mac_address":"http://jira2.domain.de/"00-01-da-f1-3d-2e",
"host_name":"Horst01"
}
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| mac_address | string |
Vollständige URL zur Jira-Instanz| Erforderlich: MAC-Adresse - dieser Parameter dient zur Identifikation des Gerätes | ab Version 1.0 |
| host_name | string | Erforderlich: Hostname |
|
| last_seen | string | Zeitpunkt wann das Gerät zuletzt erkannt wurde | ab Version 1.0 |
| user_name | string | Nutzername | ab Version 1.0 |
| ip_address | string | IP-Adresse des Endgerätes | ab Version 1.0 |
| subnet | string | Adresse des Subnetz | ab Version 1.0 |
| device_name | string | Gerätename des Switches | ab Version 1.0 |
| device | string | IP-Adresse des Switches | ab Version 1.0 |
| port | string | Portbezeichnung | ab Version 1.0 |
| port_name | string | Beschreibung des Ports | ab Version 1.0 |
| port_state | string | Art des Ports | ab Version 1.0 |
| vtp_domain | string | Name der |
Jira-Instanz| VTP-Domain | ab Version 1.0 |
| vlan | string | Bezeichnung des VLAN | ab Version 1.0 |
usernameBenutzername der Jira-Instanz| Typ des VLAN | ab Version 1.0 |
passwordPasswort der Jira-Instanz| Bemerkungen | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| message | string | ab Version 1.0 |
...
feed.virtual_device.delete
Beschreibung
Löscht eine bestehende Jira Konfigurationein bestehendes virtuelles Gerät.
Beispielaufruf
| Codeblock |
|---|
|
{
"method":"feed.virtual_device.delete",
"params":{
"apikey":"24174j3tqj",
"idmac_address":4"00-01-da-f1-3d-2e"
},
"version":"2.0",
"id": 1
} |
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|
| mac_address | string | MAC-Adresse des zu löschenden virtuellen Gerätes | ab Version 1.0 |
Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ID der zu löschenden Jira Konfiguration | ab Version 1.0 | ab Version 1.0 |
| message | string | ab Version 1.0 |
...
feed.virtual_device.delete_all
Beschreibung
Löscht alle virtuellen Geräte.
Beispielaufruf
| Codeblock |
|---|
{
"method":"feed.virtual_device.delete_all",
"params":{
"apikey":"24174j3tqj"
},
"version":"2.0",
"id": 1
} |
Parameter
keine
Rückgabewert
| Wert | Typ | Version |
|---|
| current_date | string | ab Version 1.0 |
| id | int | ab Version 1.0 |
| message | string | ab Version 1.0 |