Class: Ansible::Ruby::Modules::Cs_portforward

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb

Overview

Create, update and remove port forwarding rules.

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

#account ⇒ Object?

Returns Account the C(vm) is related to.

Returns:

  • (Object, nil) —

    Account the C(vm) is related to.



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 59

attribute :account

#domain ⇒ Object?

Returns Domain the C(vm) is related to.

Returns:

  • (Object, nil) —

    Domain the C(vm) is related to.



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 56

attribute :domain

#ip_address ⇒ String

Returns Public IP address the rule is assigned to.

Returns:

  • (String) —

    Public IP address the rule is assigned to.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 12

attribute :ip_address

#network ⇒ Object?

Returns Name of the network.

Returns:

  • (Object, nil) —

    Name of the network.



50
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 50

attribute :network

#open_firewall ⇒ Boolean?

Returns Whether the firewall rule for public port should be created, while creating the new rule.,Use M(cs_firewall) for managing firewall rules.

Returns:

  • (Boolean, nil) —

    Whether the firewall rule for public port should be created, while creating the new rule.,Use M(cs_firewall) for managing firewall rules.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 42

attribute :open_firewall

#poll_async ⇒ Boolean?

Returns Poll async jobs until job has finished.

Returns:

  • (Boolean, nil) —

    Poll async jobs until job has finished.



68
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 68

attribute :poll_async

#private_end_port ⇒ Object?

Returns End private port for this rule.,If not specified equal C(private_port).

Returns:

  • (Object, nil) —

    End private port for this rule.,If not specified equal C(private_port).



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 39

attribute :private_end_port

#private_port ⇒ Integer

Returns Start private port for this rule.

Returns:

  • (Integer) —

    Start private port for this rule.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 35

attribute :private_port

#project ⇒ Object?

Returns Name of the project the C(vm) is located in.

Returns:

  • (Object, nil) —

    Name of the project the C(vm) is located in.



62
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 62

attribute :project

#protocol ⇒ :tcp, ...

Returns Protocol of the port forwarding rule.

Returns:

  • (:tcp, :udp, nil) —

    Protocol of the port forwarding rule.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 24

attribute :protocol

#public_end_port ⇒ Object?

Returns End public port for this rule.,If not specified equal C(public_port).

Returns:

  • (Object, nil) —

    End public port for this rule.,If not specified equal C(public_port).



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 32

attribute :public_end_port

#public_port ⇒ Integer, String

Returns Start public port for this rule.

Returns:

  • (Integer, String) —

    Start public port for this rule.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 28

attribute :public_port

#state ⇒ :present, ...

Returns State of the port forwarding rule.

Returns:

  • (:present, :absent, nil) —

    State of the port forwarding rule.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 20

attribute :state

#tags ⇒ Object?

Returns List of tags. Tags are a list of dictionaries having keys C(key) and C(value).,To delete all tags, set a empty list e.g. C(tags: []).

Returns:

  • (Object, nil) —

    List of tags. Tags are a list of dictionaries having keys C(key) and C(value).,To delete all tags, set a empty list e.g. C(tags: []).



72
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 72

attribute :tags

#vm ⇒ String?

Returns Name of virtual machine which we make the port forwarding rule for.,Required if C(state=present).

Returns:

  • (String, nil) —

    Name of virtual machine which we make the port forwarding rule for.,Required if C(state=present).



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 16

attribute :vm

#vm_guest_ip ⇒ Boolean?

Returns VM guest NIC secondary IP address for the port forwarding rule.

Returns:

  • (Boolean, nil) —

    VM guest NIC secondary IP address for the port forwarding rule.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 46

attribute :vm_guest_ip

#vpc ⇒ Object?

Returns Name of the VPC.

Returns:

  • (Object, nil) —

    Name of the VPC.



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 53

attribute :vpc

#zone ⇒ Object?

Returns Name of the zone in which the virtual machine is in.,If not set, default zone is used.

Returns:

  • (Object, nil) —

    Name of the zone in which the virtual machine is in.,If not set, default zone is used.



65
 
# File 'lib/ansible/ruby/modules/generated/cloud/cloudstack/cs_portforward.rb', line 65

attribute :zone