Class: Ansible::Ruby::Modules::Azure_rm_networkinterface

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb

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, #to_h, validates

Constructor Details

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

Instance Method Details

#location ⇒ String?

Returns Valid azure location. Defaults to location of the resource group.

Returns:

  • (String, nil) —

    Valid azure location. Defaults to location of the resource group.



22
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 22

attribute :location

#name ⇒ String

Returns Name of the network interface.

Returns:

  • (String) —

    Name of the network interface.



14
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 14

attribute :name

#open_ports ⇒ Object?

Returns When a default security group is created for a Linux host a rule will be added allowing inbound TCP connections to the default SSH port 22, and for a Windows host rules will be added allowing inbound access to RDP ports 3389 and 5986. Override the default ports by providing a list of open ports.

Returns:

  • (Object, nil) —

    When a default security group is created for a Linux host a rule will be added allowing inbound TCP connections to the default SSH port 22, and for a Windows host rules will be added allowing inbound access to RDP ports 3389 and 5986. Override the default ports by providing a list of open ports.



61
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 61

attribute :open_ports

#os_type ⇒ :Windows, ...

Returns Determines any rules to be added to a default security group. When creating a network interface, if no security group name is provided, a default security group will be created. If the os_type is ‘Windows’, a rule will be added allowing RDP access. If the os_type is ‘Linux’, a rule allowing SSH access will be added.

Returns:

  • (:Windows, :Linux, nil) —

    Determines any rules to be added to a default security group. When creating a network interface, if no security group name is provided, a default security group will be created. If the os_type is ‘Windows’, a rule will be added allowing RDP access. If the os_type is ‘Linux’, a rule allowing SSH access will be added.



34
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 34

attribute :os_type

#private_ip_address ⇒ Object?

Returns Valid IPv4 address that falls within the specified subnet.

Returns:

  • (Object, nil) —

    Valid IPv4 address that falls within the specified subnet.



38
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 38

attribute :private_ip_address

#private_ip_allocation_method ⇒ :Dynamic, ...

Returns Specify whether or not the assigned IP address is permanent. NOTE: when creating a network interface specifying a value of ‘Static’ requires that a private_ip_address value be provided. You can update the allocation method to ‘Static’ after a dynamic private ip address has been assigned.

Returns:

  • (:Dynamic, :Static, nil) —

    Specify whether or not the assigned IP address is permanent. NOTE: when creating a network interface specifying a value of ‘Static’ requires that a private_ip_address value be provided. You can update the allocation method to ‘Static’ after a dynamic private ip address has been assigned.



41
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 41

attribute :private_ip_allocation_method

#public_ip ⇒ Boolean?

Returns When creating a network interface, if no public IP address name is provided a default public IP address will be created. Set to false, if you do not want a public IP address automatically created.

Returns:

  • (Boolean, nil) —

    When creating a network interface, if no public IP address name is provided a default public IP address will be created. Set to false, if you do not want a public IP address automatically created.



45
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 45

attribute :public_ip

#public_ip_address_name ⇒ String?

Returns Name of an existing public IP address object to associate with the security group.

Returns:

  • (String, nil) —

    Name of an existing public IP address object to associate with the security group.



49
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 49

attribute :public_ip_address_name

#public_ip_allocation_method ⇒ :Dynamic, ...

Returns If a public_ip_address_name is not provided, a default public IP address will be created. The allocation method determines whether or not the public IP address assigned to the network interface is permanent.

Returns:

  • (:Dynamic, :Static, nil) —

    If a public_ip_address_name is not provided, a default public IP address will be created. The allocation method determines whether or not the public IP address assigned to the network interface is permanent.



53
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 53

attribute :public_ip_allocation_method

#resource_group ⇒ String

Returns Name of a resource group where the network interface exists or will be created.

Returns:

  • (String) —

    Name of a resource group where the network interface exists or will be created.



10
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 10

attribute :resource_group

#security_group_name ⇒ String?

Returns Name of an existing security group with which to associate the network interface. If not provided, a default security group will be created.

Returns:

  • (String, nil) —

    Name of an existing security group with which to associate the network interface. If not provided, a default security group will be created.



57
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 57

attribute :security_group_name

#state ⇒ :absent, ...

Returns Assert the state of the network interface. Use ‘present’ to create or update an interface and ‘absent’ to delete an interface.

Returns:

  • (:absent, :present, nil) —

    Assert the state of the network interface. Use ‘present’ to create or update an interface and ‘absent’ to delete an interface.



18
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 18

attribute :state

#subnet_name ⇒ String?

Returns Name of an existing subnet within the specified virtual network. Required when creating a network interface.

Returns:

  • (String, nil) —

    Name of an existing subnet within the specified virtual network. Required when creating a network interface



30
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 30

attribute :subnet_name

#virtual_network_name ⇒ String?

Returns Name of an existing virtual network with which the network interface will be associated. Required when creating a network interface.

Returns:

  • (String, nil) —

    Name of an existing virtual network with which the network interface will be associated. Required when creating a network interface.



26
 
# File 'lib/ansible/ruby/modules/generated/core/cloud/azure/azure_rm_networkinterface.rb', line 26

attribute :virtual_network_name