ansible-ruby 1.0.0

data/lib/ansible/ruby/modules/generated/core/network/cumulus/cl_img_install.rb

@@ -0,0 +1,22 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Cl_img_install < Base
+        # @return [Object] full path to the Cumulus Linux binary image. Can be a local path, http or https URL. If the code version is in the name of the file, the module will assume this is the version of code you wish to install.
+        attribute :src
+        validates :src, presence: true
+
+        # @return [Object, nil] inform the module of the exact version one is installing. This overrides the automatic check of version in the file name. For example, if the binary file name is called CumulusLinux-2.2.3.bin, and version is set to '2.5.0', then the module will assume it is installing '2.5.0' not '2.2.3'. If version is not included, then the module will assume '2.2.3' is the version to install.
+        attribute :version
+
+        # @return [:yes, :no, nil] Switch slots after installing the image. To run the installed code, reboot the switch
+        attribute :switch_slot
+        validates :switch_slot, inclusion: {:in=>[:yes, :no], :message=>"%{value} needs to be :yes, :no"}, allow_nil: true
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/cumulus/cl_interface.rb

@@ -0,0 +1,70 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Cl_interface < Base
+        # @return [Object] name of the interface
+        attribute :name
+        validates :name, presence: true
+
+        # @return [Object, nil] add a port description
+        attribute :alias_name
+
+        # @return [Object, nil] list of IPv4 addresses to configure on the interface. use X.X.X.X/YY syntax.
+        attribute :ipv4
+
+        # @return [Object, nil] list of IPv6 addresses  to configure on the interface. use X:X:X::X/YYY syntax
+        attribute :ipv6
+
+        # @return [Object, nil] can be loopback for loopback interfaces or dhcp for dhcp interfaces.
+        attribute :addr_method
+
+        # @return [Object, nil] set speed of the swp(front panel) or management(eth0) interface. speed is in MB
+        attribute :speed
+
+        # @return [Object, nil] set MTU. Configure Jumbo Frame by setting MTU to 9000.
+        attribute :mtu
+
+        # @return [Object, nil] define IPv4 virtual IP used by the Cumulus VRR feature
+        attribute :virtual_ip
+
+        # @return [Object, nil] define Ethernet mac associated with Cumulus VRR feature
+        attribute :virtual_mac
+
+        # @return [Object, nil] in vlan aware mode, lists vlans defined under the interface
+        attribute :vids
+
+        # @return [Object, nil] Enables BPDU Guard on a port in vlan-aware mode
+        attribute :mstpctl_bpduguard
+
+        # @return [Object, nil] Enables bridge assurance in vlan-aware mode
+        attribute :mstpctl_portnetwork
+
+        # @return [Object, nil] Enables admin edge port
+        attribute :mstpctl_portadminedge
+
+        # @return [Object, nil] Enables the clagd daemon. This command should only be applied to the clag peerlink interface
+        attribute :clagd_enable
+
+        # @return [Object, nil] Integer that changes the role the switch has in the clag domain. The lower priority switch will assume the primary role. The number can be between 0 and 65535
+        attribute :clagd_priority
+
+        # @return [Object, nil] IP address of the directly connected peer switch interface
+        attribute :clagd_peer_ip
+
+        # @return [Object, nil] Clagd system mac address. Recommended to use the range starting with 44:38:39:ff. Needs to be the same between 2 Clag switches
+        attribute :clagd_sys_mac
+
+        # @return [Object, nil] in vlan aware mode, defines vlan that is the untagged vlan
+        attribute :pvid
+
+        # @return [String, nil] interface directory location
+        attribute :location
+        validates :location, type: String
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/cumulus/cl_interface_policy.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 Cl_interface_policy < Base
+        # @return [Array<String>, String, nil] list of ports to run initial run at 10G
+        attribute :allowed
+        validates :allowed, type: TypeGeneric.new(String)
+
+        # @return [String, nil] folder to store interface files.
+        attribute :location
+        validates :location, type: String
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/cumulus/cl_license.rb

@@ -0,0 +1,17 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Cl_license < Base
+        # @return [Object, nil] full path to the license. Can be local path or http url
+        attribute :src
+
+        # @return [Object, nil] force installation of a license. Typically not needed. It is recommended to manually run this command via the ansible command. A reload of switchd is not required. Running the force option in a playbook will break the idempotent state machine of the module and cause the switchd notification to kick in all the time, causing a disruption.
+        attribute :force
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/cumulus/cl_ports.rb

@@ -0,0 +1,23 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Cl_ports < Base
+        # @return [Object, nil] list of ports to run initial run at 10G
+        attribute :speed_10g
+
+        # @return [Object, nil] list of ports to run initial run at 40G
+        attribute :speed_40g
+
+        # @return [Object, nil] list of 40G ports that will be unganged to run as 4 10G ports.
+        attribute :speed_4_by_10g
+
+        # @return [Object, nil] list of 10G ports that will be ganged to form a 40G port
+        attribute :speed_40g_div_4
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/eos/eos_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 Eos_command < Base
+        # @return [Array<String>, String] The commands to send to the remote EOS 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 retries has been exceeded.
+        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 be 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/eos/eos_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 Eos_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/eos/eos_eapi.rb

@@ -0,0 +1,43 @@
+# See LICENSE.txt at root of repository
+# GENERATED FILE - DO NOT EDIT!!
+require 'ansible/ruby/modules/base'
+
+module Ansible
+  module Ruby
+    module Modules
+      class Eos_eapi < Base
+        # @return [:started, :stopped, nil] Set to started or stopped. A state of started will enable EAPI access, and a state of stopped will disable or shutdown all EAPI 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 [Integer, nil] Port on which the local HTTP server will listen.
+        attribute :local_http_port
+        validates :local_http_port, type: Integer
+
+        # @return [Boolean, nil] Enable HTTP server access.
+        attribute :http
+        validates :http, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Boolean, nil] Enable HTTPS server access.
+        attribute :https
+        validates :https, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Boolean, nil] Enable local HTTP server access.
+        attribute :local_http
+        validates :local_http, inclusion: {:in=>[true, false], :message=>"%{value} needs to be true, false"}, allow_nil: true
+
+        # @return [Boolean, nil] Enable Unix socket server access.
+        attribute :socket
+        validates :socket, 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/eos/eos_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 Eos_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] 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 [Boolean, nil] By default when the M(eos_template) connects to the remote device to retrieve the configuration it will issue the `show running-config` command.  If this option is set to True then the issued command will be `show running-config all`
+        attribute :include_defaults
+        validates :include_defaults, 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 [Boolean, nil] This argument will cause the provided configuration to be replaced on the destination node.   The use of the replace argument will always cause the task to set changed to true and will implies I(force) is true.  This argument is only valid with I(transport) is eapi.
+        attribute :replace
+        validates :replace, 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 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
+        validates :config, type: String
+      end
+    end
+  end
+end

data/lib/ansible/ruby/modules/generated/core/network/ios/ios_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 Ios_command < Base
+        # @return [Array<String>, String] List of commands to send to the remote ios 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] List of conditions to evaluate against the output of the command. The task will wait for a each condition to be true before moving forward. If the conditional is not true within the configured number of 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 conditions.
+        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 conditions, the interval indicates how 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/ios/ios_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 Ios_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/ios/ios_template.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 Ios_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 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, presence: true, 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] The module, by default, will collect the current device running-config to use as a base for comparision to the commands in I(src).  Setting this value to true will cause the command issued to add any necessary flags to collect all defaults as well as the device configuration.  If the destination device does not support such a flag, this argument is silently ignored.
+        attribute :include_defaults
+        validates :include_defaults, 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/iosxr/iosxr_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 Iosxr_command < Base
+        # @return [Array<String>, String] List of commands to send to the remote ios 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] List of conditions to evaluate against the output of the command. The task will wait for a each condition to be true before moving forward. If the conditional is not true within the configured number of 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 conditions.
+        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 conditions, the interval indicates how long to wait before trying the command again.
+        attribute :interval
+        validates :interval, type: Integer
+      end
+    end
+  end
+end