Line

Line configuration controls the behavior of console, default (VTY), and named template terminal lines on Cisco IOS-XR routers. Console is the physical out-of-band management interface. Default applies to all VTY lines for remote access via SSH or Telnet. Templates define named, reusable terminal line profiles that can be applied to VTY lines.

Diagram

Classes

configuration (iosxr.devices)

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

line (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory
console	Class	`[console]`	No
default	Class	`[default]`	No
templates	List	`[templates]`	No

console (iosxr.devices.configuration.line)

Name	Type	Constraint	Mandatory
absolute_timeout	Integer	min: `0`, max: `10000`	No
access_class_egress	String		No
access_class_ingress	String		No
accounting_commands	String		No
accounting_exec	String		No
authorization_commands	String		No
authorization_eventmanager	String		No
authorization_exec	String		No
cli_whitespace_completion	Boolean	`true`, `false`	No
disconnect_character	String		No
escape_character	String		No
exec_timeout_minutes	Integer	min: `0`, max: `35791`	No
exec_timeout_seconds	Integer	min: `0`, max: `2147483`	No
length	Integer	min: `0`, max: `512`	No
login_authentication	String		No
pager	Choice	`less`, `more`, `none`	No
password	String		No
password_type	Choice	`0`, `7`	No
secret	String		No
secret_type	Choice	`0`, `5`	No
session_limit	Integer	min: `0`, max: `20`	No
session_timeout	Integer	min: `0`, max: `35791`	No
session_timeout_output	Boolean	`true`, `false`	No
telnet_transparent	Boolean	`true`, `false`	No
timeout_login_response	Integer	min: `0`, max: `300`	No
timestamp_disable	Boolean	`true`, `false`	No
transport_input	Any	List[Choice[`all`, `none`, `ssh`, `telnet`]]	No
transport_output	Any	List[Choice[`all`, `none`, `ssh`, `telnet`]]	No
transport_preferred	Choice	`none`, `ssh`, `telnet`	No
user_groups	List	`[user_groups]`	No
width	Integer	min: `0`, max: `512`	No

default (iosxr.devices.configuration.line)

Name	Type	Constraint	Mandatory
absolute_timeout	Integer	min: `0`, max: `10000`	No
access_class_egress	String		No
access_class_ingress	String		No
accounting_commands	String		No
accounting_exec	String		No
authorization_commands	String		No
authorization_eventmanager	String		No
authorization_exec	String		No
autocommand	String		No
cli_whitespace_completion	Boolean	`true`, `false`	No
disconnect_character	String		No
escape_character	String		No
exec_timeout_minutes	Integer	min: `0`, max: `35791`	No
exec_timeout_seconds	Integer	min: `0`, max: `2147483`	No
length	Integer	min: `0`, max: `512`	No
login_authentication	String		No
pager	Choice	`less`, `more`, `none`	No
password	String		No
password_type	Choice	`0`, `7`	No
secret	String		No
secret_type	Choice	`0`, `5`	No
session_limit	Integer	min: `0`, max: `20`	No
session_timeout	Integer	min: `0`, max: `35791`	No
session_timeout_output	Boolean	`true`, `false`	No
telnet_transparent	Boolean	`true`, `false`	No
timeout_login_response	Integer	min: `0`, max: `300`	No
timestamp_disable	Boolean	`true`, `false`	No
transport_input	Any	List[Choice[`all`, `none`, `ssh`, `telnet`]]	No
transport_output	Any	List[Choice[`all`, `none`, `ssh`, `telnet`]]	No
transport_preferred	Choice	`none`, `ssh`, `telnet`	No
user_groups	List	`[user_groups]`	No
width	Integer	min: `0`, max: `512`	No

templates (iosxr.devices.configuration.line)

Name	Type	Constraint	Mandatory
name	String		Yes
absolute_timeout	Integer	min: `0`, max: `10000`	No
access_class_egress	String		No
access_class_ingress	String		No
accounting_commands	String		No
accounting_exec	String		No
authorization_commands	String		No
authorization_eventmanager	String		No
authorization_exec	String		No
autocommand	String		No
cli_whitespace_completion	Boolean	`true`, `false`	No
disconnect_character	String		No
escape_character	String		No
exec_timeout_minutes	Integer	min: `0`, max: `35791`	No
exec_timeout_seconds	Integer	min: `0`, max: `2147483`	No
length	Integer	min: `0`, max: `512`	No
login_authentication	String		No
pager	Choice	`less`, `more`, `none`	No
password	String		No
password_type	Choice	`0`, `7`	No
secret	String		No
secret_type	Choice	`0`, `5`	No
session_limit	Integer	min: `0`, max: `20`	No
session_timeout	Integer	min: `0`, max: `35791`	No
session_timeout_output	Boolean	`true`, `false`	No
telnet_transparent	Boolean	`true`, `false`	No
timeout_login_response	Integer	min: `0`, max: `300`	No
timestamp_disable	Boolean	`true`, `false`	No
transport_input	Any	List[Choice[`all`, `none`, `ssh`, `telnet`]]	No
transport_output	Any	List[Choice[`all`, `none`, `ssh`, `telnet`]]	No
transport_preferred	Choice	`none`, `ssh`, `telnet`	No
user_groups	List	`[user_groups]`	No
width	Integer	min: `0`, max: `512`	No

user_groups (iosxr.devices.configuration.line.console)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

user_groups (iosxr.devices.configuration.line.default)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

user_groups (iosxr.devices.configuration.line.templates)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes

Sample CLI Configuration:

line console
 access-class ingress ACL1
 access-class egress ACL1
 exec-timeout 30 0
 session-limit 15
 session-timeout 1440 output
 timeout login response 60
 absolute-timeout 3600
 width 80
 length 25
 transport input ssh
 transport output ssh telnet
 transport preferred ssh
 timestamp disable
 pager none
 telnet transparent
 cli-whitespace-completion
 users group cisco-support
 users group netadmin
!
line default
 access-class ingress ACL1
 access-class egress ACL1
 exec-timeout 30 0
 session-limit 15
 session-timeout 1440 output
 timeout login response 60
 absolute-timeout 3600
 width 80
 length 25
 transport input ssh
 transport output ssh telnet
 transport preferred ssh
 timestamp disable
 telnet transparent
 cli-whitespace-completion
 users group cisco-support
!
line template template-1
 access-class ingress ACL1
 access-class egress ACL1
 exec-timeout 30 0
 session-limit 15
 session-timeout 1440 output
 timeout login response 60
 absolute-timeout 3600
 width 81
 length 25
 transport input ssh
 transport output ssh telnet
 transport preferred ssh
 timestamp disable
 telnet transparent
 cli-whitespace-completion
 users group cisco-support
!

Example YAML Code:

Example-1: Configure line console timeouts, session limits, and secret.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        line:
          console:
            exec_timeout_minutes: 30
            exec_timeout_seconds: 0
            session_timeout: 1440
            session_timeout_output: true
            session_limit: 15
            absolute_timeout: 3600
            timeout_login_response: 60
            secret_type: 5
            secret: "$1$UgkY$I2SEocww.URG7gvDI7oz01"

Example-2: Configure line console terminal display settings.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        line:
          console:
            width: 81
            length: 25
            timestamp_disable: true
            pager: none
            cli_whitespace_completion: true

Example-3: Configure a line template with password.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        line:
          templates:
            - name: template-1
              access_class_ingress: ACL1
              access_class_egress: ACL1
              transport_input:
                - ssh
                - telnet
              transport_output:
                - ssh
                - telnet
              transport_preferred: ssh
              exec_timeout_minutes: 30
              exec_timeout_seconds: 0
              session_timeout: 1440
              session_timeout_output: true
              session_limit: 15
              absolute_timeout: 3600
              timeout_login_response: 60
              password_type: 7
              password: "cisco"