This YANG module provides a Netgate-defined data-model for SYSTEM data.
Copyright 2018-2019 Rubicon Communications, LLC.
Example URL
System group operational state.
netgate.system.SystemState
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system-state" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
Contains vendor-specific information for identifying the system platform and operating system.
netgate.system.systemstate.Platform
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system-state/netgate-system:platform" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
System group configuration.
netgate.system.System
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
System group configuration.
netgate.system.System to be added to list
name | string The name of the host. This name can be a single domain label or the fully qualified domain name of the host. |
description | string A textual description of the entity. This value should include the full name and version identification of the system's hardware type, software operating-system, and networking software. It is mandatory that this only contain printable ASCII characters. |
location | string The system location.
|
auth | object (netgate.system.system.Auth) |
contact | string The administrator contact information for the system. A server implementation MAY map this leaf to the sysContact MIB object. Such an implementation needs to use some mechanism to handle the differences in size and characters allowed between this leaf and sysContact. The definition of such a mechanism is outside the scope of this document. REF:RFC 3418: Management Information Base (MIB) for the Simple Network Management Protocol (SNMP) SNMPv2-MIB.sysContact |
Object created
Internal error
Object already exists
Example URL
System group configuration.
netgate.system.System to be added or updated
netgate-system:system | object (netgate.system.System) |
Object created
Object modified
Internal error
Example URL
System group configuration.
Object deleted
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system" req, _ := http.NewRequest("DELETE", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
returns netgate.system.system.Auth
netgate.system.system.Auth
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system/netgate-system:auth" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
creates netgate.system.system.Auth
netgate.system.system.Auth to be added to list
system-certificate | string |
user | Array of objects (netgate.system.system.auth.User) allowed users of the system |
Object created
Internal error
Object already exists
Example URL
creates or updates netgate.system.system.Auth
netgate.system.system.Auth to be added or updated
netgate-system:auth | object (netgate.system.system.Auth) |
Object created
Object modified
Internal error
Example URL
removes netgate.system.system.Auth
Object deleted
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system/netgate-system:auth" req, _ := http.NewRequest("DELETE", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
allowed users of the system
netgate.system.system.auth.User to be added to list
user-password | string the hash of the users password |
user-name | string user name identifying user |
user-keys | Array of objects (netgate.system.system.auth.user.UserKeys) list of users pubic keys |
Object created
Internal error
Object already exists
Example URL
allowed users of the system
user-name required | string Id of user |
netgate.system.system.auth.User
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system/netgate-system:auth/netgate-system:user=%7Buser-name%7D" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
allowed users of the system
user-name required | string Id of user |
netgate.system.system.auth.User to be added to list
user-password | string the hash of the users password |
user-name | string user name identifying user |
user-keys | Array of objects (netgate.system.system.auth.user.UserKeys) list of users pubic keys |
Object created
Internal error
Object already exists
Example URL
allowed users of the system
user-name required | string Id of user |
netgate.system.system.auth.User to be added or updated
netgate-system:user | object (netgate.system.system.auth.User) |
Object created
Object modified
Internal error
Example URL
allowed users of the system
user-name required | string Id of user |
Object deleted
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system/netgate-system:auth/netgate-system:user=%7Buser-name%7D" req, _ := http.NewRequest("DELETE", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
list of users pubic keys
user-name required | string Id of user |
netgate.system.system.auth.user.UserKeys to be added to list
key-name | string A unique arbitrary name for this key |
key-protocol | string The key protocol, one of ssh-dsa, ssh-edcsa, ssh-ed25519, ssh-rsa. |
key-data | string ASCII encoded data for user key. |
Object created
Internal error
Object already exists
Example URL
list of users pubic keys
user-name required | string Id of user |
key-name required | string Id of user-keys |
netgate.system.system.auth.user.UserKeys
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system/netgate-system:auth/netgate-system:user=%7Buser-name%7D/netgate-system:user-keys=%7Bkey-name%7D" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
list of users pubic keys
user-name required | string Id of user |
key-name required | string Id of user-keys |
netgate.system.system.auth.user.UserKeys to be added to list
key-name | string A unique arbitrary name for this key |
key-protocol | string The key protocol, one of ssh-dsa, ssh-edcsa, ssh-ed25519, ssh-rsa. |
key-data | string ASCII encoded data for user key. |
Object created
Internal error
Object already exists
Example URL
list of users pubic keys
user-name required | string Id of user |
key-name required | string Id of user-keys |
netgate.system.system.auth.user.UserKeys to be added or updated
netgate-system:user-keys | object (netgate.system.system.auth.user.UserKeys) |
Object created
Object modified
Internal error
Example URL
list of users pubic keys
user-name required | string Id of user |
key-name required | string Id of user-keys |
Object deleted
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-system:system/netgate-system:auth/netgate-system:user=%7Buser-name%7D/netgate-system:user-keys=%7Bkey-name%7D" req, _ := http.NewRequest("DELETE", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
creates netgate.system.SystemPing
input | object (netgate.system.systemping.Input) |
Correct response
No response
Internal error
Example URL
Correct response
No response
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/operations/netgate-system:system-running-to-startup" req, _ := http.NewRequest("POST", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) }
Example URL
creates netgate.system.SystemTraceroute
input | object (netgate.system.systemtraceroute.Input) |
Correct response
No response
Internal error