ibm_cloud_power 2.1.0 → 3.0.0

data/docs/NetworkAddressTranslation.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkAddressTranslation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_ip** | **String** | source IP address, required if network peer type is L3BGP or L3STATIC and if Network Address Translation (NAT) is enabled  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkAddressTranslation.new(
+  source_ip: null
+)
+```
+

data/docs/NetworkCloudConnections.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::NetworkCloudConnections
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cloud_connection_id** | **String** | the cloud connection id | [optional] |
+| **href** | **String** | link to the cloud connection resource | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkCloudConnections.new(
+  cloud_connection_id: null,
+  href: null
+)
+```
+

data/docs/NetworkCreate.md

@@ -4,13 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **access_config** | [**AccessConfig**](AccessConfig.md) |  | [optional] |
 | **cidr** | **String** | Network in CIDR notation (192.168.0.0/24) | [optional] |
 | **dns_servers** | **Array<String>** | DNS Servers. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network) | [optional] |
 | **gateway** | **String** | Gateway IP Address | [optional] |
 | **ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | IP Address Ranges | [optional] |
-| **jumbo** | **Boolean** | Enable MTU Jumbo Network | [optional] |
+| **jumbo** | **Boolean** | (deprecated - replaced by mtu) Enable MTU Jumbo Network (for multi-zone locations only) | [optional] |
+| **mtu** | **Integer** | Maximum transmission unit | [optional] |
 | **name** | **String** | Network Name | [optional] |
-| **type** | **String** | Type of Network - 'vlan' (private network) 'pub-vlan' (public network) | [default to 'vlan'] |
+| **type** | **String** | Type of Network - 'vlan' (private network) 'pub-vlan' (public network) 'dhcp-vlan' (for satellite locations only) | [default to 'vlan'] |
 
 ## Example
 
@@ -18,11 +20,13 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::NetworkCreate.new(
+  access_config: null,
   cidr: null,
   dns_servers: null,
   gateway: null,
   ip_address_ranges: null,
   jumbo: null,
+  mtu: null,
   name: null,
   type: null
 )

data/docs/NetworkInterface.md

@@ -0,0 +1,36 @@
+# IbmCloudPower::NetworkInterface
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **crn** | **String** | The Network Interface's crn |  |
+| **id** | **String** | The unique Network Interface ID |  |
+| **instance** | [**NetworkInterfaceInstance**](NetworkInterfaceInstance.md) |  | [optional] |
+| **ip_address** | **String** | The ip address of this Network Interface |  |
+| **mac_address** | **String** | The mac address of the Network Interface |  |
+| **name** | **String** | Name of the Network Interface (not unique or indexable) |  |
+| **network_security_group_id** | **String** | (deprecated - replaced by networkSecurityGroupIDs) ID of the Network Security Group the network interface will be added to | [optional] |
+| **network_security_group_ids** | **Array<String>** | Network security groups that the network interface is a member of. | [optional] |
+| **status** | **String** | The status of the network address group |  |
+| **user_tags** | **Array<String>** | The user tags associated with this resource. | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkInterface.new(
+  crn: null,
+  id: null,
+  instance: null,
+  ip_address: null,
+  mac_address: null,
+  name: null,
+  network_security_group_id: null,
+  network_security_group_ids: null,
+  status: null,
+  user_tags: null
+)
+```
+

data/docs/NetworkInterfaceCreate.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::NetworkInterfaceCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_address** | **String** | The requested IP address of this Network Interface | [optional] |
+| **name** | **String** | Name of the Network Interface | [optional] |
+| **user_tags** | **Array<String>** | The user tags associated with this resource. | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkInterfaceCreate.new(
+  ip_address: null,
+  name: null,
+  user_tags: null
+)
+```
+

data/docs/NetworkInterfaceInstance.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::NetworkInterfaceInstance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **href** | **String** | Link to instance resource | [optional] |
+| **instance_id** | **String** | The attached instance ID | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkInterfaceInstance.new(
+  href: null,
+  instance_id: null
+)
+```
+

data/docs/NetworkInterfaceUpdate.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::NetworkInterfaceUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **instance_id** | **String** | If supplied populated it attaches to the InstanceID, if empty detaches from InstanceID | [optional] |
+| **name** | **String** | Name of the Network Interface | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkInterfaceUpdate.new(
+  instance_id: null,
+  name: null
+)
+```
+

data/docs/NetworkInterfaces.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkInterfaces
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interfaces** | [**Array<NetworkInterface>**](NetworkInterface.md) | Network Interfaces |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkInterfaces.new(
+  interfaces: null
+)
+```
+

data/docs/NetworkPortPvmInstance.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **href** | **String** | Link to pvm-instance resource | [optional] |
-| **pvm_instance_id** | **String** | The attahed pvm-instance ID | [optional] |
+| **pvm_instance_id** | **String** | The attached pvm-instance ID | [optional] |
 
 ## Example
 

data/docs/NetworkReference.md

@@ -4,12 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **access_config** | [**AccessConfig**](AccessConfig.md) |  | [optional] |
+| **crn** | **String** |  | [optional] |
 | **dhcp_managed** | **Boolean** | DHCP Managed Network | [optional] |
 | **href** | **String** | Link to Network resource |  |
-| **jumbo** | **Boolean** | MTU Jumbo Network enabled |  |
+| **jumbo** | **Boolean** | (deprecated - replaced by mtu) Enable MTU Jumbo Network (for multi-zone locations only) | [optional] |
+| **mtu** | **Integer** | Maximum transmission unit | [optional] |
 | **name** | **String** | Network Name |  |
 | **network_id** | **String** | Unique Network ID |  |
-| **type** | **String** | Type of Network {vlan, pub-vlan} | [default to 'vlan'] |
+| **type** | **String** | Type of Network - 'vlan' (private network) 'pub-vlan' (public network) 'dhcp-vlan' (for satellite locations only) | [default to 'vlan'] |
 | **vlan_id** | **Float** | VLAN ID |  |
 
 ## Example
@@ -18,9 +21,12 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::NetworkReference.new(
+  access_config: null,
+  crn: null,
   dhcp_managed: null,
   href: null,
   jumbo: null,
+  mtu: null,
   name: null,
   network_id: null,
   type: null,

data/docs/NetworkSecurityGroup.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::NetworkSecurityGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **crn** | **String** | The Network Security Group's crn |  |
+| **default** | **Boolean** | Indicates if the Network Security Group is the default Network Security Group in the workspace | [optional] |
+| **id** | **String** | The ID of the Network Security Group |  |
+| **members** | [**Array<NetworkSecurityGroupMember>**](NetworkSecurityGroupMember.md) | The list of IPv4 addresses and\\or Network Interfaces in the Network Security Group | [optional] |
+| **name** | **String** | The name of the Network Security Group |  |
+| **rules** | [**Array<NetworkSecurityGroupRule>**](NetworkSecurityGroupRule.md) | The list of rules in the Network Security Group | [optional] |
+| **user_tags** | **Array<String>** | The user tags associated with this resource. | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroup.new(
+  crn: null,
+  default: null,
+  id: null,
+  members: null,
+  name: null,
+  rules: null,
+  user_tags: null
+)
+```
+

data/docs/NetworkSecurityGroupAddMember.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::NetworkSecurityGroupAddMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **target** | **String** | The target member to add. An IP4 address if ipv4-address type or a network interface ID if network-interface type |  |
+| **type** | **String** | The type of member |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupAddMember.new(
+  target: null,
+  type: null
+)
+```
+

data/docs/NetworkSecurityGroupAddRule.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::NetworkSecurityGroupAddRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | The action to take if the rule matches network traffic |  |
+| **destination_port** | [**NetworkSecurityGroupRulePort**](NetworkSecurityGroupRulePort.md) |  | [optional] |
+| **destination_ports** | [**NetworkSecurityGroupRulePort**](NetworkSecurityGroupRulePort.md) |  | [optional] |
+| **protocol** | [**NetworkSecurityGroupRuleProtocol**](NetworkSecurityGroupRuleProtocol.md) |  |  |
+| **remote** | [**NetworkSecurityGroupRuleRemote**](NetworkSecurityGroupRuleRemote.md) |  |  |
+| **source_port** | [**NetworkSecurityGroupRulePort**](NetworkSecurityGroupRulePort.md) |  | [optional] |
+| **source_ports** | [**NetworkSecurityGroupRulePort**](NetworkSecurityGroupRulePort.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupAddRule.new(
+  action: null,
+  destination_port: null,
+  destination_ports: null,
+  protocol: null,
+  remote: null,
+  source_port: null,
+  source_ports: null
+)
+```
+

data/docs/NetworkSecurityGroupClone.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkSecurityGroupClone
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the cloned network security group |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupClone.new(
+  name: null
+)
+```
+

data/docs/NetworkSecurityGroupCreate.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::NetworkSecurityGroupCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the Network Security Group |  |
+| **user_tags** | **Array<String>** | The user tags associated with this resource. | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupCreate.new(
+  name: null,
+  user_tags: null
+)
+```
+

data/docs/NetworkSecurityGroupMember.md

@@ -0,0 +1,26 @@
+# IbmCloudPower::NetworkSecurityGroupMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the member in a Network Security Group |  |
+| **mac_address** | **String** | The mac address of a Network Interface included if the type is network-interface | [optional] |
+| **network_interface_network_id** | **String** | The network ID of a Network Interface included if the type is network-interface | [optional] |
+| **target** | **String** | If ipv4-address type, then IPv4 address or if network-interface type, then network interface ID |  |
+| **type** | **String** | The type of member |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupMember.new(
+  id: null,
+  mac_address: null,
+  network_interface_network_id: null,
+  target: null,
+  type: null
+)
+```
+

data/docs/NetworkSecurityGroupMoveMember.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::NetworkSecurityGroupMoveMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member_id** | **String** | The member to move |  |
+| **network_security_group_id** | **String** | The ID of the Network Security Group the member will be moved to |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupMoveMember.new(
+  member_id: null,
+  network_security_group_id: null
+)
+```
+

data/docs/NetworkSecurityGroupRule.md

@@ -0,0 +1,28 @@
+# IbmCloudPower::NetworkSecurityGroupRule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | The action to take if the rule matches network traffic |  |
+| **destination_port** | [**NetworkSecurityGroupRulePort**](NetworkSecurityGroupRulePort.md) |  | [optional] |
+| **id** | **String** | The ID of the rule in a Network Security Group |  |
+| **protocol** | [**NetworkSecurityGroupRuleProtocol**](NetworkSecurityGroupRuleProtocol.md) |  |  |
+| **remote** | [**NetworkSecurityGroupRuleRemote**](NetworkSecurityGroupRuleRemote.md) |  |  |
+| **source_port** | [**NetworkSecurityGroupRulePort**](NetworkSecurityGroupRulePort.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupRule.new(
+  action: null,
+  destination_port: null,
+  id: null,
+  protocol: null,
+  remote: null,
+  source_port: null
+)
+```
+

data/docs/NetworkSecurityGroupRulePort.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::NetworkSecurityGroupRulePort
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maximum** | **Integer** | The end of the port range, if applicable. If the value is not present then the default value of 65535 will be the maximum port number. | [optional] |
+| **minimum** | **Integer** | The start of the port range, if applicable. If the value is not present then the default value of 1 will be the minimum port number. | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupRulePort.new(
+  maximum: null,
+  minimum: null
+)
+```
+

data/docs/NetworkSecurityGroupRuleProtocol.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::NetworkSecurityGroupRuleProtocol
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **icmp_type** | **String** | If icmp type, a ICMP packet type affected by ICMP rules and if not present then all types are matched | [optional] |
+| **tcp_flags** | [**Array<NetworkSecurityGroupRuleProtocolTcpFlag>**](NetworkSecurityGroupRuleProtocolTcpFlag.md) | If tcp type, the list of TCP flags and if not present then all flags are matched | [optional] |
+| **type** | **String** | The protocol of the network traffic | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupRuleProtocol.new(
+  icmp_type: null,
+  tcp_flags: null,
+  type: null
+)
+```
+

data/docs/NetworkSecurityGroupRuleProtocolTcpFlag.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkSecurityGroupRuleProtocolTcpFlag
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flag** | **String** | TCP flag | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupRuleProtocolTcpFlag.new(
+  flag: null
+)
+```
+

data/docs/NetworkSecurityGroupRuleRemote.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::NetworkSecurityGroupRuleRemote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the remote Network Address Group or Network Security Group the rules apply to. Not required for default-network-address-group | [optional] |
+| **type** | **String** | The type of remote group the rules apply to | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupRuleRemote.new(
+  id: null,
+  type: null
+)
+```
+

data/docs/NetworkSecurityGroupUpdate.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkSecurityGroupUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Replaces the current Network Security Group Name | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupUpdate.new(
+  name: null
+)
+```
+

data/docs/NetworkSecurityGroups.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkSecurityGroups
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_security_groups** | [**Array<NetworkSecurityGroup>**](NetworkSecurityGroup.md) | list of Network Security Groups | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroups.new(
+  network_security_groups: null
+)
+```
+

data/docs/NetworkSecurityGroupsAction.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkSecurityGroupsAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Name of the action to take; can be enable to enable NSGs in a workspace or disable to disable NSGs in a workspace |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkSecurityGroupsAction.new(
+  action: null
+)
+```
+