ibm_cloud_power 1.1.1 → 2.0.0

data/docs/Error.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | **String** |  | [optional] 
-**description** | **String** |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  | [optional] |
+| **error** | **String** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::Error.new(error: null,
-                                 description: null)
+instance = IbmCloudPower::Error.new(
+  description: null,
+  error: null
+)
 ```
 
-

data/docs/Event.md

@@ -2,32 +2,33 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**event_id** | **String** | ID of the Activity | 
-**time** | **DateTime** | Time of activity in ISO 8601 - RFC3339 | 
-**timestamp** | **Integer** | Time of activity in unix epoch | 
-**user** | [**EventUser**](EventUser.md) |  | [optional] 
-**level** | **String** | Level of the event (notice, info, warning, error) | 
-**resource** | **String** | Type of resource for this event | 
-**action** | **String** | Type of action for this event | 
-**message** | **String** | The (translated) message of the event | 
-**metadata** | **Object** | Any metadata associated with the event | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | ID of the Activity |  |
+| **time** | **Time** | Time of activity in ISO 8601 - RFC3339 |  |
+| **timestamp** | **Integer** | Time of activity in unix epoch |  |
+| **user** | [**EventUser**](EventUser.md) |  | [optional] |
+| **level** | **String** | Level of the event (notice, info, warning, error) |  |
+| **resource** | **String** | Type of resource for this event |  |
+| **action** | **String** | Type of action for this event |  |
+| **message** | **String** | The (translated) message of the event |  |
+| **metadata** | **Object** | Any metadata associated with the event | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::Event.new(event_id: null,
-                                 time: null,
-                                 timestamp: null,
-                                 user: null,
-                                 level: null,
-                                 resource: null,
-                                 action: null,
-                                 message: null,
-                                 metadata: null)
+instance = IbmCloudPower::Event.new(
+  event_id: null,
+  time: null,
+  timestamp: null,
+  user: null,
+  level: null,
+  resource: null,
+  action: null,
+  message: null,
+  metadata: null
+)
 ```
 
-

data/docs/EventUser.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**user_id** | **String** | ID of user who created/caused the event | 
-**name** | **String** | Name of the User | [optional] 
-**email** | **String** | Email of the User | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | ID of user who created/caused the event |  |
+| **name** | **String** | Name of the User | [optional] |
+| **email** | **String** | Email of the User | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::EventUser.new(user_id: null,
-                                 name: null,
-                                 email: null)
+instance = IbmCloudPower::EventUser.new(
+  user_id: null,
+  name: null,
+  email: null
+)
 ```
 
-

data/docs/Events.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**events** | [**Array<Event>**](Event.md) | Events | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<Event>**](Event.md) | Events |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::Events.new(events: null)
+instance = IbmCloudPower::Events.new(
+  events: null
+)
 ```
 
-

data/docs/ExportImage.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bucket_name** | **String** | Cloud Object Storage Bucket name | 
-**region** | **String** | Cloud Object Storage Region; required for IBM COS | [optional] 
-**access_key** | **String** | Cloud Object Storage Access key | 
-**secret_key** | **String** | Cloud Object Storage Secret key | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bucket_name** | **String** | Cloud Object Storage Bucket name |  |
+| **region** | **String** | Cloud Object Storage Region; required for IBM COS | [optional] |
+| **access_key** | **String** | Cloud Object Storage Access key |  |
+| **secret_key** | **String** | Cloud Object Storage Secret key | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::ExportImage.new(bucket_name: null,
-                                 region: null,
-                                 access_key: null,
-                                 secret_key: null)
+instance = IbmCloudPower::ExportImage.new(
+  bucket_name: null,
+  region: null,
+  access_key: null,
+  secret_key: null
+)
 ```
 
-

data/docs/IKEPolicies.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::IKEPolicies
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ike_policies** | [**Array<IKEPolicy>**](IKEPolicy.md) | IKE Policies array |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IKEPolicies.new(
+  ike_policies: null
+)
+```
+

data/docs/IKEPolicy.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::IKEPolicy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | **String** | authentication of the IKE Policy |  |
+| **dh_group** | **Integer** | DH group of the IKE Policy |  |
+| **encryption** | **String** | encryption of the IKE Policy |  |
+| **id** | **String** | unique identifier of the IKE Policy object |  |
+| **key_lifetime** | **Integer** | Policy key lifetime |  |
+| **name** | **String** | name of the IKE Policy |  |
+| **version** | **Integer** | version of the IKE Policy |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IKEPolicy.new(
+  authentication: sha1,
+  dh_group: 19,
+  encryption: 3des-cbc,
+  id: 7edc8988-eb18-4b5c-a594-0d73d8254463,
+  key_lifetime: 28800,
+  name: ikePolicy1,
+  version: 2
+)
+```
+

data/docs/IKEPolicyCreate.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::IKEPolicyCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | **String** | authentication of the IKE Policy |  |
+| **dh_group** | **Integer** | DH group of the IKE Policy |  |
+| **encryption** | **String** | encryption of the IKE Policy |  |
+| **key_lifetime** | **Integer** | Policy key lifetime |  |
+| **name** | **String** | name of the IKE Policy |  |
+| **preshared_key** | **String** | Preshared key used in this IKE Policy (length of preshared key must be even) |  |
+| **version** | **Integer** | version of the IKE Policy |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IKEPolicyCreate.new(
+  authentication: sha1,
+  dh_group: 19,
+  encryption: 3des-cbc,
+  key_lifetime: 28800,
+  name: ikePolicy1,
+  preshared_key: null,
+  version: 2
+)
+```
+

data/docs/IKEPolicyOptions.md

@@ -0,0 +1,24 @@
+# IbmCloudPower::IKEPolicyOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentications** | **Array<String>** |  |  |
+| **dh_groups** | **Array<Float>** |  |  |
+| **encryptions** | **Array<String>** |  |  |
+| **versions** | **Array<Float>** |  |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IKEPolicyOptions.new(
+  authentications: ["sha1","md5","sha-256","sha-384"],
+  dh_groups: [1,2,5,14,19,20,24],
+  encryptions: ["3des-cbc","aes-128-cbc","aes-128-gcm","aes-192-cbc","aes-256-cbc","aes-256-gcm","des-cbc"],
+  versions: [1,2]
+)
+```
+

data/docs/IKEPolicyRef.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::IKEPolicyRef
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | unique identifier of IKE Policy |  |
+| **name** | **String** | name of IKE Policy |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IKEPolicyRef.new(
+  id: 6edc8988-ab18-4b5c-b123-0d73e8254463,
+  name: IKE Policy 1
+)
+```
+

data/docs/IKEPolicyTemplate.md

@@ -0,0 +1,26 @@
+# IbmCloudPower::IKEPolicyTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | **String** | ikePolicy Authentication default value |  |
+| **dh_group** | **Integer** | ikePolicy DHGroup default value |  |
+| **encryption** | **String** | ikePolicy Encryption default value |  |
+| **key_lifetime** | **Integer** | Policy key lifetime |  |
+| **version** | **Float** | ikePolicy Version default value |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IKEPolicyTemplate.new(
+  authentication: sha256,
+  dh_group: 2,
+  encryption: 3des-cbc,
+  key_lifetime: 28800,
+  version: 1
+)
+```
+

data/docs/IKEPolicyUpdate.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::IKEPolicyUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | **String** | authentication of the IKE Policy | [optional] |
+| **dh_group** | **Integer** | DH group of the IKE Policy | [optional] |
+| **encryption** | **String** | encryption of the IKE Policy | [optional] |
+| **key_lifetime** | **Integer** | Policy key lifetime | [optional] |
+| **name** | **String** | name of the IKE Policy | [optional] |
+| **preshared_key** | **String** | Preshared key used in this IKE Policy (length of preshared key must be even) | [optional] |
+| **version** | **Integer** | version of the IKE Policy | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IKEPolicyUpdate.new(
+  authentication: sha1,
+  dh_group: 19,
+  encryption: 3des-cbc,
+  key_lifetime: 28800,
+  name: ikePolicy1,
+  preshared_key: null,
+  version: 2
+)
+```
+

data/docs/IPAddressRange.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**starting_ip_address** | **String** | Starting IP Address | 
-**ending_ip_address** | **String** | Ending IP Address | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **starting_ip_address** | **String** | Starting IP Address |  |
+| **ending_ip_address** | **String** | Ending IP Address |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::IPAddressRange.new(starting_ip_address: null,
-                                 ending_ip_address: null)
+instance = IbmCloudPower::IPAddressRange.new(
+  starting_ip_address: null,
+  ending_ip_address: null
+)
 ```
 
-

data/docs/IPSecPolicies.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::IPSecPolicies
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_sec_policies** | [**Array<IPSecPolicy>**](IPSecPolicy.md) | IPSec Policies array |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IPSecPolicies.new(
+  ip_sec_policies: null
+)
+```
+

data/docs/IPSecPolicy.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::IPSecPolicy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | **String** | authentication encryption type |  |
+| **dh_group** | **Integer** | Diffie-Hellman group |  |
+| **encryption** | **String** | connection encryption policy |  |
+| **id** | **String** | unique identifier of the IPSec Policy |  |
+| **key_lifetime** | **Integer** | Policy key lifetime |  |
+| **name** | **String** | IPSec Policy name |  |
+| **pfs** | **Boolean** | Perfect Forward Secrecy |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IPSecPolicy.new(
+  authentication: null,
+  dh_group: 2,
+  encryption: 3des-cbc,
+  id: 6edc8988-eb18-4b5c-a594-0d73d8254463,
+  key_lifetime: 28800,
+  name: ipSecPolicy2,
+  pfs: true
+)
+```
+

data/docs/IPSecPolicyCreate.md

@@ -0,0 +1,28 @@
+# IbmCloudPower::IPSecPolicyCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | **String** | authentication encryption type |  |
+| **dh_group** | **Integer** | Diffie-Hellman group |  |
+| **encryption** | **String** | connection encryption policy |  |
+| **key_lifetime** | **Integer** | Policy key lifetime |  |
+| **name** | **String** | IPSec Policy name |  |
+| **pfs** | **Boolean** | Perfect Forward Secrecy |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IPSecPolicyCreate.new(
+  authentication: null,
+  dh_group: 2,
+  encryption: 3des-cbc,
+  key_lifetime: 28800,
+  name: ipSecPolicy2,
+  pfs: true
+)
+```
+

data/docs/IPSecPolicyOptions.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::IPSecPolicyOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentications** | **Array<String>** |  |  |
+| **dh_groups** | **Array<Float>** |  |  |
+| **encryptions** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IPSecPolicyOptions.new(
+  authentications: ["sha1","sha2","sha-256"],
+  dh_groups: [1,2,5,14,19,20],
+  encryptions: ["3des-cbc","aes-128-cbc","aes-128-gcm","aes-256-cbc","aes-256-gcm","des-cbc"]
+)
+```
+

data/docs/IPSecPolicyRef.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::IPSecPolicyRef
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | unique identifier of IPSec Policy |  |
+| **name** | **String** | name of IPSec Policy |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IPSecPolicyRef.new(
+  id: 7abc1234-ab18-4b5c-b123-0d73e8254463,
+  name: IPSec Policy 1
+)
+```
+

data/docs/IPSecPolicyTemplate.md

@@ -0,0 +1,24 @@
+# IbmCloudPower::IPSecPolicyTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | **String** | ipSecPolicy Authentication default value |  |
+| **dh_group** | **Integer** | ipSecPolicy DHGroup default value |  |
+| **encryption** | **String** | ipSecPolicy Encryption default value |  |
+| **key_lifetime** | **Integer** | Policy key lifetime |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IPSecPolicyTemplate.new(
+  authentication: sha256,
+  dh_group: 2,
+  encryption: 3des-cbc,
+  key_lifetime: 28800
+)
+```
+

data/docs/IPSecPolicyUpdate.md

@@ -0,0 +1,28 @@
+# IbmCloudPower::IPSecPolicyUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authentication** | **String** | authentication encryption type | [optional] |
+| **dh_group** | **Integer** | Diffie-Hellman group | [optional] |
+| **encryption** | **String** | connection encryption policy | [optional] |
+| **key_lifetime** | **Integer** | Policy key lifetime | [optional] |
+| **name** | **String** | IPSec Policy name | [optional] |
+| **pfs** | **Boolean** | Perfect Forward Secrecy | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::IPSecPolicyUpdate.new(
+  authentication: null,
+  dh_group: 2,
+  encryption: 3des-cbc,
+  key_lifetime: 28800,
+  name: ipSecPolicy2,
+  pfs: true
+)
+```
+

data/docs/Image.md

@@ -2,40 +2,41 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**image_id** | **String** | Image ID | 
-**name** | **String** | Image Name | 
-**state** | **String** | Image State | [optional] 
-**description** | **String** | Description | [optional] 
-**size** | **Float** | Image Size | 
-**storage_type** | **String** | Storage type for image | 
-**storage_pool** | **String** | Storage pool where the image is located | 
-**creation_date** | **DateTime** | Creation Date | 
-**last_update_date** | **DateTime** | Last Update Date | 
-**specifications** | [**ImageSpecifications**](ImageSpecifications.md) |  | [optional] 
-**volumes** | [**Array<ImageVolume>**](ImageVolume.md) | Image Volumes | [optional] 
-**servers** | **Array<String>** | List of Servers that have deployed the image | [optional] 
-**taskref** | [**TaskReference**](TaskReference.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_id** | **String** | Image ID |  |
+| **name** | **String** | Image Name |  |
+| **state** | **String** | Image State | [optional] |
+| **description** | **String** | Description | [optional] |
+| **size** | **Float** | Image Size |  |
+| **storage_type** | **String** | Storage type for image |  |
+| **storage_pool** | **String** | Storage pool where the image is located |  |
+| **creation_date** | **Time** | Creation Date |  |
+| **last_update_date** | **Time** | Last Update Date |  |
+| **specifications** | [**ImageSpecifications**](ImageSpecifications.md) |  | [optional] |
+| **volumes** | [**Array<ImageVolume>**](ImageVolume.md) | Image Volumes | [optional] |
+| **servers** | **Array<String>** | List of Servers that have deployed the image | [optional] |
+| **taskref** | [**TaskReference**](TaskReference.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::Image.new(image_id: null,
-                                 name: null,
-                                 state: null,
-                                 description: null,
-                                 size: null,
-                                 storage_type: null,
-                                 storage_pool: null,
-                                 creation_date: null,
-                                 last_update_date: null,
-                                 specifications: null,
-                                 volumes: null,
-                                 servers: null,
-                                 taskref: null)
+instance = IbmCloudPower::Image.new(
+  image_id: null,
+  name: null,
+  state: null,
+  description: null,
+  size: null,
+  storage_type: null,
+  storage_pool: null,
+  creation_date: null,
+  last_update_date: null,
+  specifications: null,
+  volumes: null,
+  servers: null,
+  taskref: null
+)
 ```
 
-