MacsecProperties

class oci.core.models.MacsecProperties(**kwargs)

Bases: object

Properties used for MACsec (if capable).

Attributes:

ENCRYPTION_CIPHER_AES128_GCM

A constant which can be used with the encryption_cipher property of a MacsecProperties.

ENCRYPTION_CIPHER_AES128_GCM_XPN

A constant which can be used with the encryption_cipher property of a MacsecProperties.

ENCRYPTION_CIPHER_AES256_GCM

A constant which can be used with the encryption_cipher property of a MacsecProperties.

ENCRYPTION_CIPHER_AES256_GCM_XPN

A constant which can be used with the encryption_cipher property of a MacsecProperties.

STATE_DISABLED

A constant which can be used with the state property of a MacsecProperties.

STATE_ENABLED

A constant which can be used with the state property of a MacsecProperties.

encryption_cipher

Gets the encryption_cipher of this MacsecProperties.

is_unprotected_traffic_allowed

Gets the is_unprotected_traffic_allowed of this MacsecProperties.

primary_key

Gets the primary_key of this MacsecProperties.

state

[Required] Gets the state of this MacsecProperties.

Methods:

__init__(**kwargs)

Initializes a new MacsecProperties object with values from keyword arguments.

ENCRYPTION_CIPHER_AES128_GCM = 'AES128_GCM'

A constant which can be used with the encryption_cipher property of a MacsecProperties. This constant has a value of “AES128_GCM”

ENCRYPTION_CIPHER_AES128_GCM_XPN = 'AES128_GCM_XPN'

A constant which can be used with the encryption_cipher property of a MacsecProperties. This constant has a value of “AES128_GCM_XPN”

ENCRYPTION_CIPHER_AES256_GCM = 'AES256_GCM'

A constant which can be used with the encryption_cipher property of a MacsecProperties. This constant has a value of “AES256_GCM”

ENCRYPTION_CIPHER_AES256_GCM_XPN = 'AES256_GCM_XPN'

A constant which can be used with the encryption_cipher property of a MacsecProperties. This constant has a value of “AES256_GCM_XPN”

STATE_DISABLED = 'DISABLED'

A constant which can be used with the state property of a MacsecProperties. This constant has a value of “DISABLED”

STATE_ENABLED = 'ENABLED'

A constant which can be used with the state property of a MacsecProperties. This constant has a value of “ENABLED”

__init__(**kwargs)

Initializes a new MacsecProperties object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • state (str) – The value to assign to the state property of this MacsecProperties. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • primary_key (oci.core.models.MacsecKey) – The value to assign to the primary_key property of this MacsecProperties.

  • encryption_cipher (str) – The value to assign to the encryption_cipher property of this MacsecProperties. Allowed values for this property are: “AES128_GCM”, “AES128_GCM_XPN”, “AES256_GCM”, “AES256_GCM_XPN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • is_unprotected_traffic_allowed (bool) – The value to assign to the is_unprotected_traffic_allowed property of this MacsecProperties.

property encryption_cipher

Gets the encryption_cipher of this MacsecProperties. Type of encryption cipher suite to use for the MACsec connection.

Allowed values for this property are: “AES128_GCM”, “AES128_GCM_XPN”, “AES256_GCM”, “AES256_GCM_XPN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The encryption_cipher of this MacsecProperties.

Return type

str

property is_unprotected_traffic_allowed

Gets the is_unprotected_traffic_allowed of this MacsecProperties. Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.

Returns

The is_unprotected_traffic_allowed of this MacsecProperties.

Return type

bool

property primary_key

Gets the primary_key of this MacsecProperties.

Returns

The primary_key of this MacsecProperties.

Return type

oci.core.models.MacsecKey

property state

[Required] Gets the state of this MacsecProperties. Indicates whether or not MACsec is enabled.

Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The state of this MacsecProperties.

Return type

str