Class: Ansible::Ruby::Modules::Virt_net

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_net.rb

Overview

Manage I(libvirt) networks.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#autostart ⇒ :yes, ...

Returns Specify if a given storage pool should be started automatically on system boot.

Returns:

  • (:yes, :no, nil) —

    Specify if a given storage pool should be started automatically on system boot.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_net.rb', line 23

attribute :autostart

#command ⇒ :define, ...

Returns in addition to state management, various non-idempotent commands are available. See examples.

Returns:

  • (:define, :create, :start, :stop, :destroy, :undefine, :get_xml, :list_nets, :facts, :info, :status, nil) —

    in addition to state management, various non-idempotent commands are available. See examples.



19
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_net.rb', line 19

attribute :command

#name ⇒ String

Returns name of the network being managed. Note that network must be previously defined with xml.

Returns:

  • (String) —

    name of the network being managed. Note that network must be previously defined with xml.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_net.rb', line 11

attribute :name

#state ⇒ :active, ...

Returns specify which state you want a network to be in. If ‘active’, network will be started. If ‘present’, ensure that network is present but do not change its state; if it’s missing, you need to specify xml argument. If ‘inactive’, network will be stopped. If ‘undefined’ or ‘absent’, network will be removed from I(libvirt) configuration.

Returns:

  • (:active, :inactive, :present, :absent, nil) —

    specify which state you want a network to be in. If ‘active’, network will be started. If ‘present’, ensure that network is present but do not change its state; if it’s missing, you need to specify xml argument. If ‘inactive’, network will be stopped. If ‘undefined’ or ‘absent’, network will be removed from I(libvirt) configuration.



15
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_net.rb', line 15

attribute :state

#uri ⇒ String?

Returns libvirt connection uri.

Returns:

  • (String, nil) —

    libvirt connection uri.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_net.rb', line 27

attribute :uri

#xml ⇒ String?

Returns XML document used with the define command.

Returns:

  • (String, nil) —

    XML document used with the define command.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/cloud/misc/virt_net.rb', line 31

attribute :xml