ansible-ruby 1.0.0

data/lib/ansible/ruby/modules/generated/core/network/iosxr/iosxr_config.rb

@@ -0,0 +1,41 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Iosxr_config < Base
+        # @return [Array<String>, String] The ordered set of commands that should be configured in the section.  The commands must be the exact same commands as found in the device running-config.  Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
+        attribute :lines
+        validates :lines, presence: true, type: TypeGeneric.new(String)
+
+        # @return [Array<String>, String, nil] The ordered set of parents that uniquely identify the section the commands should be checked against.  If the parents argument is omitted, the commands are checked against the set of top level or global commands.
+        attribute :parents
+        validates :parents, type: TypeGeneric.new(String)
+
+        # @return [Array<String>, String, nil] The ordered set of commands to push on to the command stack if a change needs to be made.  This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system
+        attribute :before
+        validates :before, type: TypeGeneric.new(String)
+
+        # @return [Object, nil] The ordered set of commands to append to the end of the command stack if a changed needs to be made.  Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set.
+        attribute :after
+
+        # @return [:line, :strict, :exact, nil] Instructs the module on the way to perform the matching of the set of commands against the current device config.  If match is set to I(line), commands are matched line by line.  If match is set to I(strict), command lines are matched with respect to position.  Finally if match is set to I(exact), command lines must be an equal match.
+        attribute :match
+        validates :match, inclusion: {:in=>[:line, :strict, :exact], :message=>"%{value} needs to be :line, :strict, :exact"}, allow_nil: true
+
+        # @return [:line, :block, nil] Instructs the module on the way to perform the configuration on the device.  If the replace argument is set to I(line) then the modified lines are pushed to the device in configuration mode.  If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct
+        attribute :replace
+        validates :replace, inclusion: {:in=>[:line, :block], :message=>"%{value} needs to be :line, :block"}, allow_nil: true
+
+        # @return [Boolean, nil] The force argument instructs the module to not consider the current devices running-config.  When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured.
+        attribute :force
+        validates :force, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Object, nil] The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source.  There are times when it is not desirable to have the task get the current running-config for every task in a playbook.  The I(config) argument allows the implementer to pass in the configuruation to use as the base config for comparision.
+        attribute :config
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/iosxr/iosxr_template.rb

@@ -0,0 +1,27 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Iosxr_template < Base
+        # @return [String, nil] The path to the config source.  The source can be either a file with config or a template that will be merged during runtime.  By default the task will first search for the source file in role or playbook root folder in templates unless a full path to the file is given.
+        attribute :src
+        validates :src, type: String
+
+        # @return [Boolean, nil] The force argument instructs the module not to consider the current device running-config.  When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured.
+        attribute :force
+        validates :force, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Boolean, nil] When this argument is configured true, the module will backup the running-config from the node prior to making any changes. The backup file will be written to backup_{{ hostname }} in the root of the playbook directory.
+        attribute :backup
+        validates :backup, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [String, nil] The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source.  There are times when it is not desirable to have the task get the current running-config for every task.  The I(config) argument allows the implementer to pass in the configuruation to use as the base config for comparision.
+        attribute :config
+        validates :config, type: String
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/junos/junos_command.rb

@@ -0,0 +1,35 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Junos_command < Base
+        # @return [Array<String>, String, nil] An ordered set of CLI commands to be executed on the remote device.  The output from the commands is then returned to the playbook in the task results.
+        attribute :commands
+        validates :commands, type: TypeGeneric.new(String)
+
+        # @return [Array<String>, String, nil] The C(rpcs) argument accepts a list of RPCs to be executed over a netconf session and the results from the RPC execution is return to the playbook via the modules results dictionary.
+        attribute :rpcs
+        validates :rpcs, type: TypeGeneric.new(String)
+
+        # @return [Array<String>, String, nil] Specifies what to evaluate from the output of the command and what conditionals to apply.  This argument will cause the task to wait for a particular conditional or set of considitonals to be true before moving forward.   If the conditional is not true by the configured retries, the task fails.  See examples.
+        attribute :waitfor
+        validates :waitfor, type: TypeGeneric.new(String)
+
+        # @return [Integer, nil] Specifies the number of retries a command should by tried before it is considered failed.  The command is run on the target device every retry and evaluated against the waitfor conditionals
+        attribute :retries
+        validates :retries, type: Integer
+
+        # @return [Integer, nil] Configures the interval in seconds to wait between retries of the command.  If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
+        attribute :interval
+        validates :interval, type: Integer
+
+        # @return [:xml, :text, nil] Configures the encoding scheme to use when serializing output from the device.  This handles how to properly understand the output and apply the conditionals path to the result set.
+        attribute :format
+        validates :format, inclusion: {:in=>[:xml, :text], :message=>"%{value} needs to be :xml, :text"}, allow_nil: true
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/junos/junos_config.rb

@@ -0,0 +1,35 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Junos_config < Base
+        # @return [Array<String>, String, nil] The path to the config source.  The source can be either a file with config or a template that will be merged during runtime.  By default the task will search for the source file in role or playbook root folder in templates directory.
+        attribute :lines
+        validates :lines, type: TypeGeneric.new(String)
+
+        # @return [Integer, nil] The C(rollback) argument instructs the module to rollback the current configuration to the identifier specified in the argument.  If the specified rollback identifier does not exist on the remote device, the module will fail.  To rollback to the most recent commit, set the C(rollback) argument to 0
+        attribute :rollback
+        validates :rollback, type: Integer
+
+        # @return [Boolean, nil] The C(zeroize) argument is used to completely ssantaize the remote device configuration back to initial defaults.  This argument will effectively remove all current configuration statements on the remote device
+        attribute :zeroize
+        validates :zeroize, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Integer, nil] The C(confirm) argument will configure a time out value for the commit to be confirmed before it is automatically rolled back.  If the C(confirm) argument is set to False, this argument is silently ignored.  If the value for this argument is set to 0, the commit is confirmed immediately.
+        attribute :confirm
+        validates :confirm, type: Integer
+
+        # @return [String, nil] The C(comment) argument specifies a text string to be used when committing the configuration.  If the C(confirm) argument is set to False, this argument is silently ignored.
+        attribute :comment
+        validates :comment, type: String
+
+        # @return [Boolean] The C(replace) argument will instruct the remote device to replace the current configuration hierarchy with the one specified in the corresponding hierarchy of the source configuraiton loaded from this module.
+        attribute :replace
+        validates :replace, presence: true, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/junos/junos_facts.rb

@@ -0,0 +1,19 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Junos_facts < Base
+        # @return [Boolean, nil] The C(config) argument instructs the fact module to collect the configuration from the remote device.  The configuration is then included in return facts.  By default, the configuration is returned as text.  The C(config_format) can be used to return different Junos configuration formats.
+        attribute :config
+        validates :config, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [:xml, :text, :set, nil] The C(config_format) argument is used to specify the desired format of the configuration file.  Devices support three configuration file formats.  By default, the configuration from the device is returned as text.  The other options include set and xml.  If the xml option is choosen, the configuration file is returned as both xml and json.
+        attribute :config_format
+        validates :config_format, inclusion: {:in=>[:xml, :text, :set], :message=>"%{value} needs to be :xml, :text, :set"}, allow_nil: true
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/junos/junos_netconf.rb

@@ -0,0 +1,19 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Junos_netconf < Base
+        # @return [Integer] This argument specifies the port the netconf service should listen on for SSH connections.  The default port as defined in RFC 6242 is 830.
+        attribute :listens_on
+        validates :listens_on, presence: true, type: Integer
+
+        # @return [:present, :absent] Specifies the state of the M(junos_netconf) resource on the remote device.  If the O(state) argument is set to I(present) the netconf service will be configured.  If the O(state) argument is set to I(absent) the netconf service will be removed from the configuration.
+        attribute :state
+        validates :state, presence: true, inclusion: {:in=>[:present, :absent], :message=>"%{value} needs to be :present, :absent"}
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/junos/junos_package.rb

@@ -0,0 +1,30 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Junos_package < Base
+        # @return [String] The O(src) argument specifies the path to the source package to be installed on the remote device in the advent of a version mismatch. The O(src) argument can be either a localized path or a full path to the package file to install
+        attribute :src
+        validates :src, presence: true, type: String
+
+        # @return [Object, nil] The O(version) argument can be used to explicitly specify the version of the package that should be installed on the remote device.  If the O(version) argument is not specified, then the version is extracts from the O(src) filename
+        attribute :version
+
+        # @return [Boolean] In order for a package to take effect, the remote device must be restarted.  When enabled, this argument will instruct the module to reboot the device once the updated package has been installed. If disabled or the remote package does not need to be changed, the device will not be started.
+        attribute :reboot
+        validates :reboot, presence: true, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}
+
+        # @return [Boolean, nil] The O(no_copy) arugment is responsible for instructing the remote device on where to isntall the package from.  When enabled, the package is transferred to the remote device prior to installing.
+        attribute :no_copy
+        validates :no_copy, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Boolean, nil] The O(force) argument instructs the module to bypass the package version check and install the packaged identified in O(src) on the remote device.
+        attribute :force
+        validates :force, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/junos/junos_template.rb

@@ -0,0 +1,35 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Junos_template < Base
+        # @return [String] The path to the config source.  The source can be either a file with config or a template that will be merged during runtime.  By default the task will search for the source file in role or playbook root folder in templates directory.
+        attribute :src
+        validates :src, presence: true, type: String
+
+        # @return [Boolean, nil] When this argument is configured true, the module will backup the configuration from the node prior to making any changes. The backup file will be written to backup_{{ hostname }} in the root of the playbook directory.
+        attribute :backup
+        validates :backup, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Integer, nil] The C(confirm) argument will configure a time out value for the commit to be confirmed before it is automatically rolled back.  If the C(confirm) argument is set to False, this argument is silently ignored.  If the value for this argument is set to 0, the commit is confirmed immediately.
+        attribute :confirm
+        validates :confirm, type: Integer
+
+        # @return [String, nil] The C(comment) argument specifies a text string to be used when committing the configuration.  If the C(confirm) argument is set to False, this argument is silently ignored.
+        attribute :comment
+        validates :comment, type: String
+
+        # @return [:merge, :overwrite, :replace, nil] The C(action) argument specifies how the module will apply changes.
+        attribute :action
+        validates :action, inclusion: {:in=>[:merge, :overwrite, :replace], :message=>"%{value} needs to be :merge, :overwrite, :replace"}, allow_nil: true
+
+        # @return [:text, :xml, :set, nil] The C(format) argument specifies the format of the configuration template specified in C(src).  If the format argument is not specified, the module will attempt to infer the configuration format based of file extension.  Files that end in I(xml) will set the format to xml.  Files that end in I(set) will set the format to set and all other files will default the format to text.
+        attribute :config_format
+        validates :config_format, inclusion: {:in=>[:text, :xml, :set], :message=>"%{value} needs to be :text, :xml, :set"}, allow_nil: true
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/nxos/nxos_command.rb

@@ -0,0 +1,27 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Nxos_command < Base
+        # @return [Array<String>, String] The commands to send to the remote NXOS device over the configured provider.  The resulting output from the command is returned.  If the I(waitfor) argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
+        attribute :commands
+        validates :commands, presence: true, type: TypeGeneric.new(String)
+
+        # @return [Array<String>, String, nil] Specifies what to evaluate from the output of the command and what conditionals to apply.  This argument will cause the task to wait for a particular conditional to be true before moving forward.   If the conditional is not true by the configured retries, the task fails.  See examples.
+        attribute :waitfor
+        validates :waitfor, type: TypeGeneric.new(String)
+
+        # @return [Integer, nil] Specifies the number of retries a command should by tried before it is considered failed.  The command is run on the target device every retry and evaluated against the waitfor conditionals
+        attribute :retries
+        validates :retries, type: Integer
+
+        # @return [Integer, nil] Configures the interval in seconds to wait between retries of the command.  If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.
+        attribute :interval
+        validates :interval, type: Integer
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/nxos/nxos_config.rb

@@ -0,0 +1,41 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Nxos_config < Base
+        # @return [Array<String>, String] The ordered set of commands that should be configured in the section.  The commands must be the exact same commands as found in the device running-config.  Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
+        attribute :lines
+        validates :lines, presence: true, type: TypeGeneric.new(String)
+
+        # @return [Array<String>, String, nil] The ordered set of parents that uniquely identify the section the commands should be checked against.  If the parents argument is omitted, the commands are checked against the set of top level or global commands.
+        attribute :parents
+        validates :parents, type: TypeGeneric.new(String)
+
+        # @return [Array<String>, String, nil] The ordered set of commands to push on to the command stack if a change needs to be made.  This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system
+        attribute :before
+        validates :before, type: TypeGeneric.new(String)
+
+        # @return [Object, nil] The ordered set of commands to append to the end of the command stack if a changed needs to be made.  Just like with I(before) this allows the playbook designer to append a set of commands to be executed after the command set.
+        attribute :after
+
+        # @return [:line, :strict, :exact, nil] Instructs the module on the way to perform the matching of the set of commands against the current device config.  If match is set to I(line), commands are matched line by line.  If match is set to I(strict), command lines are matched with respect to position.  Finally if match is set to I(exact), command lines must be an equal match.
+        attribute :match
+        validates :match, inclusion: {:in=>[:line, :strict, :exact], :message=>"%{value} needs to be :line, :strict, :exact"}, allow_nil: true
+
+        # @return [:line, :block, nil] Instructs the module on the way to perform the configuration on the device.  If the replace argument is set to I(line) then the modified lines are pushed to the device in configuration mode.  If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any line is not correct
+        attribute :replace
+        validates :replace, inclusion: {:in=>[:line, :block], :message=>"%{value} needs to be :line, :block"}, allow_nil: true
+
+        # @return [Boolean, nil] The force argument instructs the module to not consider the current devices running-config.  When set to true, this will cause the module to push the contents of I(src) into the device without first checking if already configured.
+        attribute :force
+        validates :force, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Object, nil] The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source.  There are times when it is not desirable to have the task get the current running-config for every task in a playbook.  The I(config) argument allows the implementer to pass in the configuruation to use as the base config for comparision.
+        attribute :config
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/nxos/nxos_facts.rb

@@ -0,0 +1,13 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Nxos_facts < Base
+
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/nxos/nxos_feature.rb

@@ -0,0 +1,19 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Nxos_feature < Base
+        # @return [String] Name of feature
+        attribute :feature
+        validates :feature, presence: true, type: String
+
+        # @return [:enabled, :disabled, nil] Desired state of the feature
+        attribute :state
+        validates :state, inclusion: {:in=>[:enabled, :disabled], :message=>"%{value} needs to be :enabled, :disabled"}, allow_nil: true
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/nxos/nxos_interface.rb

@@ -0,0 +1,31 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Nxos_interface < Base
+        # @return [String] Full name of interface, i.e. Ethernet1/1, port-channel10.
+        attribute :interface
+        validates :interface, presence: true, type: String
+
+        # @return [:up, :down, nil] Administrative state of the interface
+        attribute :admin_state
+        validates :admin_state, inclusion: {:in=>[:up, :down], :message=>"%{value} needs to be :up, :down"}, allow_nil: true
+
+        # @return [String, nil] Interface description
+        attribute :description
+        validates :description, type: String
+
+        # @return [:layer2, :layer3, nil] Manage Layer 2 or Layer 3 state of the interface
+        attribute :mode
+        validates :mode, inclusion: {:in=>[:layer2, :layer3], :message=>"%{value} needs to be :layer2, :layer3"}, allow_nil: true
+
+        # @return [:present, :absent, :default] Specify desired state of the resource
+        attribute :state
+        validates :state, presence: true, inclusion: {:in=>[:present, :absent, :default], :message=>"%{value} needs to be :present, :absent, :default"}
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/nxos/nxos_ip_interface.rb

@@ -0,0 +1,27 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Nxos_ip_interface < Base
+        # @return [String] Full name of interface, i.e. Ethernet1/1, vlan10
+        attribute :interface
+        validates :interface, presence: true, type: String
+
+        # @return [String, nil] IPv4 or IPv6 Address
+        attribute :addr
+        validates :addr, type: String
+
+        # @return [String, nil] Subnet mask for IPv4 or IPv6 Address in decimal format
+        attribute :mask
+        validates :mask, type: String
+
+        # @return [:present, :absent, nil] Specify desired state of the resource
+        attribute :state
+        validates :state, inclusion: {:in=>[:present, :absent], :message=>"%{value} needs to be :present, :absent"}, allow_nil: true
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/nxos/nxos_nxapi.rb

@@ -0,0 +1,35 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Nxos_nxapi < Base
+        # @return [:started, :stopped, nil] Set to started or stopped. A state of started will enable NXAPI access, and a state of stopped will disable or shutdown all NXAPI access.
+        attribute :state
+        validates :state, inclusion: {:in=>[:started, :stopped], :message=>"%{value} needs to be :started, :stopped"}, allow_nil: true
+
+        # @return [Integer, nil] Port on which the HTTP server will listen.
+        attribute :http_port
+        validates :http_port, type: Integer
+
+        # @return [Integer, nil] Port on which the HTTPS server will listen.
+        attribute :https_port
+        validates :https_port, type: Integer
+
+        # @return [Boolean, nil] Enable/disable HTTP server.
+        attribute :http
+        validates :http, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Boolean, nil] Enable/disable HTTPS server.
+        attribute :https
+        validates :https, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Boolean, nil] Enable/disable NXAPI web based UI for entering commands.
+        attribute :sandbox
+        validates :sandbox, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+      end
+    end
+  end
+end