VTY Pool

Virtual Terminal (VTY) line pools are used to manage remote access sessions. VTY pools provide logical grouping of terminal lines with customizable ranges and line templates for different services including default sessions, Embedded Event Manager (EEM), and user-defined pools. This enables granular control over concurrent remote access sessions and their configurations.

Diagram

Classes

configuration (iosxr.devices)

Name	Type	Constraint	Mandatory	Default Value
vty_pools	Class	`[vty_pools]`	No

vty_pools (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory
default	Class	`[default]`	No
eem	Class	`[eem]`	No
user_defined	List	`[user_defined]`	No

default (iosxr.devices.configuration.vty_pools)

Name	Type	Constraint	Mandatory
from_number	Integer	min: `0`, max: `0`	No
line_template	String		No
to_number	Integer	min: `4`, max: `99`	No

eem (iosxr.devices.configuration.vty_pools)

Name	Type	Constraint	Mandatory
from_number	Integer	min: `100`, max: `100`	No
line_template	String		No
to_number	Integer	min: `105`, max: `105`	No

user_defined (iosxr.devices.configuration.vty_pools)

Name	Type	Constraint	Mandatory
name	String		Yes
from_number	Any	Integer[min: `5`, max: `99`] or Integer[min: `200`, max: `299`] or String[Regex: `^.[\$\%]\{.$`]	No
line_template	String		No
to_number	Any	Integer[min: `5`, max: `99`] or Integer[min: `200`, max: `299`] or String[Regex: `^.[\$\%]\{.$`]	No

Example YAML Code:

Example-1: Configure default VTY pool with line template.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        vty_pools:
          default:
            from_number: 0
            to_number: 10
            line_template: default

Example-2: Configure EEM VTY pool for Embedded Event Manager.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        vty_pools:
          eem:
            from_number: 100
            to_number: 105
            line_template: EEM_TEMPLATE

Example-3: Configure user-defined VTY pools.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        vty_pools:
          user_defined:
            - name: USER_POOL
              from_number: 20
              to_number: 30
              line_template: USER_TEMPLATE