APIRef_tm_sys_sshd¶
mgmt/tm/sys/sshd
SSHD configuration
REST Endpoints
- Collection URI
/mgmt/tm/sys/sshd- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/sys/sshd/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
allow |
string | optional | read/write | Adds a server to or removes a server from the /etc/hosts.allow file. Use this option to either add servers to the BIG-IP system that are allowed to access the system, or delete these servers from the system. Specify “none” to disallow ssh access to the system. Specify “replace-all-with { ALL }” to allow ssh access from any server. The default value is “replace-all-with { ALL }”. | |
banner |
string | optional | read/write | Enables or disables the display of the banner text field when a user logs in to the system using SSH. The default value is disabled. | |
bannerText |
string | optional | read/write | When banner is enabled, specifies the text to include in the banner that displays when a user attempts to login to the system. | |
description |
string | optional | read/write | User defined description. | |
fipsCipherVersion |
integer | optional | read/write | Indicates if the ciphers have been set to FIPS 140-2 approved ones when the BIG-IP boots up in FIPS 140-2 mode. This is read-only for the user. The default value is 0. | |
inactivityTimeout |
integer | optional | read/write | Specifies the number of seconds before inactivity causes an SSH session to log out. The default value is 0 (zero) seconds, which indicates that inactivity timeout is disabled. | |
include |
string | optional | read/write | Warning: Do not use this parameter without assistance from the F5 Technical Support team. The system does not validate the commands issued using the include parameter. If you use this parameter incorrectly, you put the functionality of the system at risk. | |
logLevel |
string | optional | read/write | Specifies the minimum sshd message level to include in the system log. You must enter the following values: [STRIKEOUT:debug, debug1, debug2, debug3, which indicates that the minimum sshd message level that the system logs is the specified debugging level of messages.] error, which indicates that the minimum sshd message level that the system logs is error. [STRIKEOUT:fatal, which indicates that the minimum sshd message level that the system logs is fatal.] info, which indicates that the minimum sshd message level that the system logs is informational. [STRIKEOUT:quiet, which indicates that the system does not log sshd messages.] verbose, which indicates that the system logs all sshd messages. The default is info. | |
login |
string | optional | read/write | Enables or disables SSH logins to the system. The default is enabled. | |
port |
integer | optional | read/write | Specifies the TCP port to run SSHD |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.