= Cheatsheets

[[ShiroAuthOptions]]
== ShiroAuthOptions

++++
 Shiro auth configuration options, see Vert.x Auth Shiro component and/or Apache Shiro project.

 note: this will be moved to vertx-auth project after 3.1
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[config]]`config`|`Json object`|
+++
Set the Shiro auth config.
+++
|[[type]]`type`|`link:enums.html#ShiroAuthRealmType[ShiroAuthRealmType]`|
+++
Set the Shiro auth options type.
+++
|===

[[AuthOptions]]
== AuthOptions

++++
 A common base object for authentication options.

 note: this will be moved to vertx-auth project after 3.1
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|===

[[ShellServiceOptions]]
== ShellServiceOptions

++++
 The configurations options for the shell service, the shell connectors can be configured
 with link and link.
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[sshOptions]]`sshOptions`|`link:dataobjects.html#SSHOptions[SSHOptions]`|
+++
Set the SSH options, if the option is null, SSH will not be started.
+++
|[[telnetOptions]]`telnetOptions`|`link:dataobjects.html#TelnetOptions[TelnetOptions]`|
+++
Set the Telnet options, if the option is null, Telnet will not be started.
+++
|[[welcomeMessage]]`welcomeMessage`|`String`|
+++
Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.
+++
|===

[[SSHOptions]]
== SSHOptions

++++
 The SSH shell configuration options.
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[host]]`host`|`String`|
+++
Set the host
+++
|[[keyPairOptions]]`keyPairOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|
+++
Set the key pair options in jks format, aka Java keystore.
+++
|[[pemKeyPairOptions]]`pemKeyPairOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|
+++
Set the key pair store options in pem format.
+++
|[[pfxKeyPairOptions]]`pfxKeyPairOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|
+++
Set the key pair options in pfx format.
+++
|[[port]]`port`|`Number (int)`|
+++
Set the port
+++
|[[shiroAuthOptions]]`shiroAuthOptions`|`link:dataobjects.html#ShiroAuthOptions[ShiroAuthOptions]`|
+++
Set the auth options as a Shiro auth.
+++
|===

[[TelnetOptions]]
== TelnetOptions

++++
 Telnet options configuration, extends link.
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[acceptBacklog]]`acceptBacklog`|`Number (int)`|-
|[[clientAuth]]`clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|-
|[[clientAuthRequired]]`clientAuthRequired`|`Boolean`|-
|[[crlPaths]]`crlPaths`|`Array of String`|-
|[[crlValues]]`crlValues`|`Array of Buffer`|-
|[[enabledCipherSuites]]`enabledCipherSuites`|`Array of String`|-
|[[host]]`host`|`String`|-
|[[idleTimeout]]`idleTimeout`|`Number (int)`|-
|[[keyStoreOptions]]`keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[pemKeyCertOptions]]`pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[port]]`port`|`Number (int)`|-
|[[receiveBufferSize]]`receiveBufferSize`|`Number (int)`|-
|[[reuseAddress]]`reuseAddress`|`Boolean`|-
|[[sendBufferSize]]`sendBufferSize`|`Number (int)`|-
|[[soLinger]]`soLinger`|`Number (int)`|-
|[[ssl]]`ssl`|`Boolean`|-
|[[tcpKeepAlive]]`tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`tcpNoDelay`|`Boolean`|-
|[[trafficClass]]`trafficClass`|`Number (int)`|-
|[[trustStoreOptions]]`trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[usePooledBuffers]]`usePooledBuffers`|`Boolean`|-
|===

