netgate-ssh-server API (25.02)

This YANG module provides a data model for the SSH server.

ssh-server-config

returns netgate.ssh.server.SshServerConfig

Configuration for the SSH server.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config"

	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))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-ssh-server:ssh-server-config": {"netgate-ssh-server:host": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
},
"netgate-ssh-server:dataplane": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
},
"netgate-ssh-server:enable": true
}
}
}

creates netgate.ssh.server.SshServerConfig

Configuration for the SSH server.

Request Body schema: application/yang-data+json

netgate.ssh.server.SshServerConfig to be added to list

	object (netgate.ssh.server.sshserverconfig.Host) Host-specific parameters of SSH server.
	object (netgate.ssh.server.sshserverconfig.Dataplane) Dataplane-specific parameters of SSH server.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:host": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
},
"netgate-ssh-server:dataplane": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
},
"netgate-ssh-server:enable": true
}
}

creates or updates netgate.ssh.server.SshServerConfig

Configuration for the SSH server.

Request Body schema: application/yang-data+json

netgate.ssh.server.SshServerConfig to be added or updated

object (netgate.ssh.server.SshServerConfig)

Configuration for the SSH server.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:ssh-server-config": {"netgate-ssh-server:host": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
},
"netgate-ssh-server:dataplane": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
},
"netgate-ssh-server:enable": true
}
}
}

removes netgate.ssh.server.SshServerConfig

Configuration for the SSH server.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config"

	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))

}

returns netgate.ssh.server.sshserverconfig.Dataplane

Dataplane-specific parameters of SSH server.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config/dataplane"

	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))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-ssh-server:dataplane": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
},
"netgate-ssh-server:enable": true
}
}

creates netgate.ssh.server.sshserverconfig.Dataplane

Dataplane-specific parameters of SSH server.

Request Body schema: application/yang-data+json

netgate.ssh.server.sshserverconfig.Dataplane to be added to list

	object (netgate.ssh.server.sshserverconfig.dataplane.NetconfSubsystem) Dataplane netconf subsystem settings.
netgate-ssh-server:enable	boolean If true, SSH server is enabled for dataplane interfaces.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
},
"netgate-ssh-server:enable": true
}

creates or updates netgate.ssh.server.sshserverconfig.Dataplane

Dataplane-specific parameters of SSH server.

Request Body schema: application/yang-data+json

netgate.ssh.server.sshserverconfig.Dataplane to be added or updated

object (netgate.ssh.server.sshserverconfig.Dataplane)

Dataplane-specific parameters of SSH server.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:dataplane": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
},
"netgate-ssh-server:enable": true
}
}

removes netgate.ssh.server.sshserverconfig.Dataplane

Dataplane-specific parameters of SSH server.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config/dataplane"

	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))

}

returns netgate.ssh.server.sshserverconfig.dataplane.NetconfSubsystem

Dataplane netconf subsystem settings.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config/dataplane/netconf-subsystem"

	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))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
}

creates netgate.ssh.server.sshserverconfig.dataplane.NetconfSubsystem

Dataplane netconf subsystem settings.

Request Body schema: application/yang-data+json

netgate.ssh.server.sshserverconfig.dataplane.NetconfSubsystem to be added to list

netgate-ssh-server:port	integer <int32> Default: 830 TCP port for dataplane SSH server netconf subsystem.
netgate-ssh-server:enable	boolean If true, netconf subsystem is enabled for dataplane SSH server.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}

creates or updates netgate.ssh.server.sshserverconfig.dataplane.NetconfSubsystem

Dataplane netconf subsystem settings.

Request Body schema: application/yang-data+json

netgate.ssh.server.sshserverconfig.dataplane.NetconfSubsystem to be added or updated

object (netgate.ssh.server.sshserverconfig.dataplane.NetconfSubsystem)

Dataplane netconf subsystem settings.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
}

removes netgate.ssh.server.sshserverconfig.dataplane.NetconfSubsystem

Dataplane netconf subsystem settings.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config/dataplane/netconf-subsystem"

	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))

}

returns netgate.ssh.server.sshserverconfig.Host

Host-specific parameters of SSH server.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config/host"

	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))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-ssh-server:host": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
}
}

creates netgate.ssh.server.sshserverconfig.Host

Host-specific parameters of SSH server.

Request Body schema: application/yang-data+json

netgate.ssh.server.sshserverconfig.Host to be added to list

object (netgate.ssh.server.sshserverconfig.host.NetconfSubsystem)

Host netconf subsystem settings.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
}

creates or updates netgate.ssh.server.sshserverconfig.Host

Host-specific parameters of SSH server.

Request Body schema: application/yang-data+json

netgate.ssh.server.sshserverconfig.Host to be added or updated

object (netgate.ssh.server.sshserverconfig.Host)

Host-specific parameters of SSH server.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:host": {"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
}
}

removes netgate.ssh.server.sshserverconfig.Host

Host-specific parameters of SSH server.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config/host"

	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))

}

returns netgate.ssh.server.sshserverconfig.host.NetconfSubsystem

Host netconf subsystem settings.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config/host/netconf-subsystem"

	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))

}

Response samples

200

Content type

application/yang-data+json

{"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
}

creates netgate.ssh.server.sshserverconfig.host.NetconfSubsystem

Host netconf subsystem settings.

Request Body schema: application/yang-data+json

netgate.ssh.server.sshserverconfig.host.NetconfSubsystem to be added to list

netgate-ssh-server:port	integer <int32> Default: 830 TCP port for host SSH server netconf subsystem.
netgate-ssh-server:enable	boolean If true, netconf subsystem is enabled for host SSH server.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}

creates or updates netgate.ssh.server.sshserverconfig.host.NetconfSubsystem

Host netconf subsystem settings.

Request Body schema: application/yang-data+json

netgate.ssh.server.sshserverconfig.host.NetconfSubsystem to be added or updated

object (netgate.ssh.server.sshserverconfig.host.NetconfSubsystem)

Host netconf subsystem settings.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-ssh-server:netconf-subsystem": {"netgate-ssh-server:port": 830,
"netgate-ssh-server:enable": true
}
}

removes netgate.ssh.server.sshserverconfig.host.NetconfSubsystem

Host netconf subsystem settings.

Responses

Request samples

Go
javascript
Python
Shell

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-ssh-server:ssh-server-config/host/netconf-subsystem"

	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))

}

ssh-server-control

operates on netgate.ssh.server.SshServerControl

Request Body schema: application/yang-data+json

object (netgate.ssh.server.sshservercontrol.Input)

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"input": {"netgate-ssh-server:namespace": "host",
"netgate-ssh-server:operation": "start"
}
}

Response samples

200

Content type

application/yang-data+json

{"output": {"netgate-ssh-server:stdout": "string"
}
}