Class: Ansible::Ruby::Modules::Iosxr_netconf

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/iosxr/iosxr_netconf.rb

Overview

This module provides an abstraction that enables and configures the netconf system service running on Cisco IOS-XR Software. This module can be used to easily enable the Netconf API. Netconf provides a programmatic interface for working with configuration and state resources as defined in RFC 6242.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#netconf_port ⇒ Integer?

Returns This argument specifies the port the netconf service should listen on for SSH connections. The default port as defined in RFC 6242 is 830.

Returns:

  • (Integer, nil) —

    This argument specifies the port the netconf service should listen on for SSH connections. The default port as defined in RFC 6242 is 830.



12
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_netconf.rb', line 12

attribute :netconf_port

#netconf_vrf ⇒ String?

Returns netconf vrf name.

Returns:

  • (String, nil) —

    netconf vrf name



16
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_netconf.rb', line 16

attribute :netconf_vrf

#state ⇒ :present, ...

Returns Specifies the state of the C(iosxr_netconf) resource on the remote device. If the I(state) argument is set to I(present) the netconf service will be configured. If the I(state) argument is set to I(absent) the netconf service will be removed from the configuration.

Returns:

  • (:present, :absent, nil) —

    Specifies the state of the C(iosxr_netconf) resource on the remote device. If the I(state) argument is set to I(present) the netconf service will be configured. If the I(state) argument is set to I(absent) the netconf service will be removed from the configuration.



20
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_netconf.rb', line 20

attribute :state