view release on metacpan or  search on metacpan

lib/Config/Model/models/SystemSsh.pod  view on Meta::CPAN

=head1 Elements

=head2 Host

Restricts the
following declarations (up to the next B<Host> or
B<Match> keyword) to be only for those hosts that match
one of the patterns given after the keyword. If more than
one pattern is provided, they should be separated by
whitespace. A single ’*’ as a pattern can be
used to provide global defaults for all hosts. The host is
usually the I<hostname> argument given on the command
line (see the B<CanonicalizeHostname> keyword for
exceptions).See
I<PATTERNS> for more information on patterns. I< Optional. Type hash of node of class L<Ssh::HostElement|Config::Model::models::Ssh::HostElement> .  > 

=head2 AddKeysToAgent

Specifies whether keys should
be automatically added to a running L<ssh-agent(1)>. If this
option is set to B<yes> and a key is loaded from a file,
the key and its passphrase are added to the agent with the
default lifetime, as if by L<ssh-add(1)>. If this option is set
to B<ask>, L<ssh(1)> will require confirmation using the
SSH_ASKPASS program before adding a key (see L<ssh-add(1)> for
details). If this option is set to B<confirm>, each use
of the key must be confirmed, as if the B<-c> option was
specified to L<ssh-add(1)>. If this option is set to B<no>,
no keys are added to the agent. The argument must be
B<yes>, B<confirm>, B<ask>, or B<no> (the
default).Specifies whether keys should
be automatically added to a running L<ssh-agent(1)>. If this
option is set to B<yes> and a key is loaded from a file,
the key and its passphrase are added to the agent with the
default lifetime, as if by L<ssh-add(1)>. If this option is set
to B<ask>, L<ssh(1)> will require confirmation using the
SSH_ASKPASS program before adding a key (see L<ssh-add(1)> for
details). If this option is set to B<confirm>, each use
of the key must be confirmed, as if the B<-c> option was
specified to L<ssh-add(1)>. If this option is set to B<no>,
no keys are added to the agent. The argument must be
B<yes>, B<confirm>, B<ask>, or B<no> (the
default). I< Optional. Type enum. choice: 'yes', 'confirm', 'ask', 'no'.  > 

=over 4

=item upstream_default value :

no

=back



=head2 AddressFamily

Specifies which address family
to use when connecting. Valid arguments are B<any> (the
default), B<inet> (use IPv4 only), or B<inet6> (use
IPv6 only).Specifies which address family
to use when connecting. Valid arguments are B<any> (the
default), B<inet> (use IPv4 only), or B<inet6> (use
IPv6 only). I< Optional. Type enum. choice: 'any', 'inet', 'inet6'.  > 

=over 4

=item upstream_default value :

any

=back



=head2 BatchMode

If set to B<yes>,
passphrase/password querying will be disabled. In addition,
the B<ServerAliveInterval> option will be set to 300
seconds by default (Debian-specific). This option is useful
in scripts and other batch jobs where no user is present to
supply the password, and where it is desirable to detect a
broken network swiftly. The argument must be B<yes> or
B<no> (the default).If set to B<yes>,
passphrase/password querying will be disabled. In addition,
the B<ServerAliveInterval> option will be set to 300
seconds by default (Debian-specific). This option is useful
in scripts and other batch jobs where no user is present to
supply the password, and where it is desirable to detect a
broken network swiftly. The argument must be B<yes> or
B<no> (the default). I< Optional. Type boolean.  > 

=over 4

=item upstream_default value :

no

=back



=head2 BindAddress

Use the specified address on
the local machine as the source address of the connection.
Only useful on systems with more than one address.Use the specified address on
the local machine as the source address of the connection.
Only useful on systems with more than one address. I< Optional. Type uniline.  > 

=head2 BindInterface

Use the address of the
specified interface on the local machine as the source
address of the connection.Use the address of the
specified interface on the local machine as the source
address of the connection. I< Optional. Type uniline.  > 

=head2 CanonicalDomains

When
B<CanonicalizeHostname> is enabled, this option
specifies the list of domain suffixes in which to search for