Class GatewayMacsecConfig
- java.lang.Object
- 
- com.ibm.cloud.sdk.core.service.model.GenericModel
- 
- com.ibm.cloud.networking.direct_link.v1.model.GatewayMacsecConfig
 
 
- 
- All Implemented Interfaces:
- com.ibm.cloud.sdk.core.service.model.ObjectModel
 
 public class GatewayMacsecConfig extends com.ibm.cloud.sdk.core.service.model.GenericModelMACsec configuration information. For Dedicated Gateways with MACsec configured, return configuration information. Contact IBM support for access to MACsec.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static interfaceGatewayMacsecConfig.CipherSuiteSAK cipher suite.static interfaceGatewayMacsecConfig.CryptographicAlgorithmcryptographic algorithm.static interfaceGatewayMacsecConfig.SecurityPolicyPackets without MACsec headers are dropped when security_policy is `must_secure`.static interfaceGatewayMacsecConfig.StatusCurrent status of MACsec on this gateway.
 - 
Constructor SummaryConstructors Constructor Description GatewayMacsecConfig()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description GatewayMacsecConfigActiveCakgetActiveCak()Gets the activeCak.StringgetCipherSuite()Gets the cipherSuite.LonggetConfidentialityOffset()Gets the confidentialityOffset.StringgetCryptographicAlgorithm()Gets the cryptographicAlgorithm.GatewayMacsecConfigFallbackCakgetFallbackCak()Gets the fallbackCak.LonggetKeyServerPriority()Gets the keyServerPriority.GatewayMacsecConfigPrimaryCakgetPrimaryCak()Gets the primaryCak.LonggetSakExpiryTime()Gets the sakExpiryTime.StringgetSecurityPolicy()Gets the securityPolicy.StringgetStatus()Gets the status.LonggetWindowSize()Gets the windowSize.BooleanisActive()Gets the active.
 
- 
- 
- 
Method Detail- 
isActivepublic Boolean isActive() Gets the active. Indicate whether MACsec should currently be active (true) or inactive (false) for a MACsec enabled gateway. To be MACsec enabled a `macsec_config` must be specified at gateway create time.- Returns:
- the active
 
 - 
getActiveCakpublic GatewayMacsecConfigActiveCak getActiveCak() Gets the activeCak. Active connectivity association key. During normal operation `active_cak` will match the desired `primary_cak`. During CAK changes this field can be used to indicate which key is currently active on the gateway.- Returns:
- the activeCak
 
 - 
getCipherSuitepublic String getCipherSuite() Gets the cipherSuite. SAK cipher suite.- Returns:
- the cipherSuite
 
 - 
getConfidentialityOffsetpublic Long getConfidentialityOffset() Gets the confidentialityOffset. confidentiality offset.- Returns:
- the confidentialityOffset
 
 - 
getCryptographicAlgorithmpublic String getCryptographicAlgorithm() Gets the cryptographicAlgorithm. cryptographic algorithm.- Returns:
- the cryptographicAlgorithm
 
 - 
getFallbackCakpublic GatewayMacsecConfigFallbackCak getFallbackCak() Gets the fallbackCak. fallback connectivity association key.- Returns:
- the fallbackCak
 
 - 
getKeyServerPrioritypublic Long getKeyServerPriority() Gets the keyServerPriority. key server priority.- Returns:
- the keyServerPriority
 
 - 
getPrimaryCakpublic GatewayMacsecConfigPrimaryCak getPrimaryCak() Gets the primaryCak. desired primary connectivity association key.- Returns:
- the primaryCak
 
 - 
getSakExpiryTimepublic Long getSakExpiryTime() Gets the sakExpiryTime. Secure Association Key (SAK) expiry time in seconds.- Returns:
- the sakExpiryTime
 
 - 
getSecurityPolicypublic String getSecurityPolicy() Gets the securityPolicy. Packets without MACsec headers are dropped when security_policy is `must_secure`.- Returns:
- the securityPolicy
 
 - 
getStatuspublic String getStatus() Gets the status. Current status of MACsec on this gateway. Status 'offline' is returned during gateway creation and deletion.- Returns:
- the status
 
 - 
getWindowSizepublic Long getWindowSize() Gets the windowSize. replay protection window size.- Returns:
- the windowSize
 
 
- 
 
-