AclApp サービス
この章では、DCNM Web サービスの、AclApp サービスに対応する API メソッドについて説明します。
AclApp サービスについて
Access Control List(ACL; アクセス コントロール リスト)を使用して、パケットの分類およびフィルタリングを実行できます。ACL は一連のアクセス コントロール ルールを順に並べたものです。アクセス コントロール ルールは一般に Access Control Entry(ACE; アクセス コントロール エントリ)と呼ばれます。各 ACE はパケットの一致条件とアクションを指定します。
一致条件は送信元アドレス、宛先アドレス、プロトコルなどのパケット パラメータに基づいて定義できます。アクションは、指定した条件に一致するパケットを許可、または拒否します。1 つのパケットが ACL 内の複数の ACE と一致することもありますが、考慮されるのは最初に一致した ACE のみです。パケットが ACE のいずれとも一致しない場合、そのパケットはドロップされます。
ターゲットをアクティブ化するには、そのターゲットに ACL を割り当てる必要があります。このターゲットとは、レイヤ 3 インターフェイス、VLAN、またはレイヤ 2 インターフェイスです。
API カテゴリは次のとおりです。
• IPv4 ACL:IPv4 ACL が表すものは次のとおりです。
– 標準 IP アクセス リスト:送信元アドレス(IPv4 アドレス)を使用してトラフィックを分類またはフィルタします。
– 拡張 IP アクセス リスト:送信元アドレスと宛先アドレス(IPv4 アドレス)、および必要に応じてプロトコル タイプ情報を使用してトラフィックを分類またはフィルタします。
• MAC ACL:送信元 MAC アドレスと宛先 MAC アドレス、および必要に応じてプロトコル タイプ情報を使用して、トラフィックを分類またはフィルタします。
• IPv6 ACL:送信元アドレスと宛先アドレス、および必要に応じてプロトコル タイプ情報を使用して、IPv6 トラフィックを分類またはフィルタします。
• VLAN Access Map:VLAN 内でブリッジされたパケットや、VLAN にルーティングされたパケット、または VLAN からルーティングされるパケットなどすべてのパケットに対するアクセスを制御します。
• Role-Based Access Control List(RBACL):Cisco TrustSec(CTS)ドメイン内でのアクセスを制御します。
ACL サービス API は、次のカテゴリに対して定義されています。
• Query/Get API:永続的なデータベースのデータを照会します。
• Create API:新しい ACL を作成します。
• Modify API:既存の ACL を修正します。
• Delete API:既存の ACL を削除します。
• Unbind API および Unbind API:ACL およびその他の機能の間にアソシエーションをバインドおよびアンバインドします。
addRedirectNetworkInterfacesToVlanAccessMapEntry
VACE のリダイレクト インターフェイスとして、1 つまたは複数のネットワーク インターフェイスを割り当てます。その VACE にリダイレクト インターフェイスとして使用されているインターフェイスがすでに存在する場合、これらのインターフェイスがリダイレクトされたインターフェイスの既存リストに追加されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapInstanceNameId がヌル、または VlanAccessMapEntry InstanceNameId タイプではない場合。
• vlanAccessMapInstanceNameId が有効な VlanAccessMapEntry InstanceNameId ではない場合。
• networkInterfaceInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• networkInterfaceInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な NetworkInterface InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapEntryInstanceNameId:VlanAccessMapEntry オブジェクトの InstanceNameId。
networkInterfaceInstanceNameIdCol:分類またはフィルタされたトラフィックのリダイレクト先となる NetworkInterface オブジェクトの InstanceNameId のコレクション。
戻り値
void
bindIpv4AclToNetworkInterfaces
IPv4 ACL を、指定された方向の 1 つまたは複数ネットワーク インターフェイスに割り当てます。
ParameterException は、次のいずれかの状況が発生した場合にスローされます。
• ipv4AclInstanceNameId がヌル、または空の場合。
• ipv4AclInstanceNameId が有効な StandardAccessControlList または ExtendedAccessControlList InstanceNameId ではない場合。
• networkInterfaceInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• networkInterfaceInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに NetworkInterface の無効な InstanceNameId が含まれている場合。
• direction がヌルの場合。
パラメータ
opContext:動作コンテキスト。
networkInterfaceInstanceNameIdCol:NetworkInterface オブジェクトの InstanceNameId を 1 つまたは複数含むコレクション。
ipv4AclInstanceNameId:StandardAccessControlList または ExtendedAccessControlList オブジェクトの InstanceNameId。
direction:ネットワーク インターフェイス トラフィックの方向。この方向に、IPv4 ACL を適用する必要があります。方向は「IN」または「OUT」のいずれかです。
戻り値
新たに作成された AclAppliesToNetworkInterface オブジェクトのリスト。
bindIpv4AclsToVlanAccessMapEntry
トラフィックをフィルタまたは分類するために、1 つまたは複数の IPv4 ACL を VACE に適用します。その VACE に割り当てられている IPv4 ACL がすでに存在する場合、これらの IPv4 ACL は既存リストに追加されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapInstanceNameId がヌル、または VlanAccessMapEntry InstanceNameId タイプではない場合。
• vlanAccessMapInstanceNameId が有効な VlanAccessMapEntry InstanceNameId ではない場合。
• ipv4AclInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• ipv4AclInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な StandardAccessControlEntry または ExtendedAccessControlList InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapEntryInstanceNameId:VlanAccessMapEntry オブジェクトの InstanceNameId。
ipv4AclInstanceNameIdCol:1 つまたは複数の StandardAccessControlList または ExtendedAccessControlList オブジェクトの InstanceNameId のコレクション。
戻り値
void
bindIpv6AclToNetworkInterfaces
IPv6 ACL を、指定された方向の 1 つまたは複数のネットワーク インターフェイスに割り当てます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• ipv6AclInstanceNameId がヌル、または Ipv6AccessControlList InstanceNameId タイプではない場合。
• ipv6AclInstanceNameId が有効な Ipv6AccessControlList InstanceNameId ではない場合。
• networkInterfaceInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• networkInterfaceInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な NetworkInterface InstanceNameId が含まれている場合。
• direction がヌルの場合。
パラメータ
opContext:動作コンテキスト。
networkInterfaceInstanceNameIdCol:NetworkInterface オブジェクトの InstanceNameId を 1 つまたは複数含むコレクション。
ipv6AclInstanceNameId:Ipv6AccessControlList オブジェクトの InstanceNameId。
direction:ネットワーク インターフェイス トラフィックの方向。この方向に、IPv6 ACL を適用する必要があります。方向は「IN」または「OUT」です。
戻り値
新たに作成された AclAppliesToNetworkInterface オブジェクトのリスト。
bindIpv6AclsToVlanAccessMapEntry
トラフィックをフィルタまたは分類するために、1 つまたは複数の IPv6 ACL を VACE に適用します。その VACE に割り当てられている IPv6 ACL がすでに存在する場合、これらの IPv6 ACL は既存リストに追加されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapInstanceNameId がヌル、または VlanAccessMapEntry InstanceNameId タイプではない場合。
• vlanAccessMapInstanceNameId が有効な VlanAccessMapEntry InstanceNameId ではない場合。
• ipv6AclInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• ipv6AclInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な Ipv6AccessControlList InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapEntryInstanceNameId:VlanAccessMapEntry オブジェクトの InstanceNameId。
ipv6AclInstanceNameIdCol:1 つまたは複数の Ipv6AccessControlList オブジェクトの InstanceNameId のコレクション。
戻り値
void
bindMacAclToNetworkInterfaces
MAC ACL を、指定された方向の 1 つまたは複数のネットワーク インターフェイスに割り当てます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• macAclInstanceNameId がヌル、または MacAccessControlList InstanceNameId タイプではない場合。
• macAclInstanceNameId が有効な MacAccessControlList InstanceNameId ではない場合。
• networkInterfaceInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• networkInterfaceInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な NetworkInterface InstanceNameId が含まれている場合。
• direction がヌルの場合。
パラメータ
opContext:動作コンテキスト。
networkInterfaceInstanceNameIdCol:NetworkInterface オブジェクトの InstanceNameId を 1 つまたは複数含むコレクション。
macAclInstanceNameId:MacAccessControlList オブジェクトの InstanceNameId。
direction:ネットワーク インターフェイス トラフィックの方向。この方向に、MAC ACL を適用する必要があります。
戻り値
新たに作成された AclAppliesToNetworkInterface オブジェクトのリスト。
bindMacAclsToVlanAccessMapEntry
トラフィックをフィルタまたは分類するために、1 つまたは複数の MAC ACL を VACE に適用します。その VACE に割り当てられている MAC ACL がすでに存在する場合、これらの MAC ACL は既存リストに追加されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapInstanceNameId がヌル、または VlanAccessMapEntry InstanceNameId タイプではない場合。
• vlanAccessMapInstanceNameId が有効な VlanAccessMapEntry InstanceNameId ではない場合。
• macAclInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• macAclInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な MacAccessControlList InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapEntryInstanceNameId:VlanAccessMapEntry オブジェクトの InstanceNameId。
macAclInstanceNameIdCol:1 つまたは複数の MacAccessControlList オブジェクトの InstanceNameId のコレクション。
戻り値
void
bindTimeRangeToAces
1 つまたは複数の ACE に時間範囲を割り当てます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• timerangeInstanceNameId がヌル、または TimeRange InstanceNameId タイプではない場合。
• timerangeInstanceNameId が有効な TimeRange InstanceNameId ではない場合。
• aceInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• aceInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な ExtendedAccessControlList、Ipv6AccessControlList、または RoleBasedAccessControlList InstanceNameId が含まれている場合。
• direction がヌルの場合。
パラメータ
opContext:動作コンテキスト。
aceInstanceNameIdCol:時間範囲の割り当て先である拡張 ACE、IPv6 ACE、またはロール ベース ACE のリスト。
timerangeInstanceNameId:timerange オブジェクトのインスタンス名 ID。
戻り値
void
bindVlanAccessMapToVlans
1 つまたは複数の VLAN に VACL を割り当てます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapEntryInstanceNameId がヌル、または VlanAccessMap InstanceNameId タイプではない場合。
• vlanAccessMapEntryInstanceNameId が有効な VlanAccessMap InstanceNameId ではない場合。
• vlanIds がヌルの場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapInstanceNameId:VlanAccessMap オブジェクトの InstanceNameId。
vlanIds:VLAN を一意に識別するための 1 つまたは複数の VLAN ID。
戻り値
void
createExtendedIpAcls
ネットワーク要素内に 1 つまたは複数の拡張 IP ACL オブジェクトを作成します。ネットワーク要素の InstanceNameId および拡張 IP ACL オブジェクトのリストを指定すると、サーバにこのオブジェクトを作成し、そのインスタンス名 ID を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• extendedIpAclCol コレクションがヌル、またはこのコレクションが空である場合。
• extendedIpAclCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションに ExtendedAccessControlList タイプではないオブジェクトが含まれている場合。
• ExtendedAccessControlList 内の ExtendedAccessControlEntry にシーケンス番号が含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• extendedIpAclCol コレクションでは、ExtendedAccessControlList アトリビュートが 1 つも有効ではない、または拡張 ACL 内の ExtendedAccessControlEntry が有効ではない場合。
例:
• ACL 名が数字で始まる。これは ACL 名にはスペースや引用符は使用できず、また番号付きアクセス リストとの混同を避けるために英字で始まらなければならないと決められているからです。
• ACL の remark アトリビュート値に 101 文字以上が含まれている。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• すでにデータベースに存在する ExtendedAccessControlList が extendedIpAclCol に含まれている場合。
• extendedIpAclCol 内の ExtendedAccessControlList に重複する ExtendedAccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。拡張 ACL とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。拡張 ACL をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
extendedIpAclCol:作成が必要な拡張 ACL オブジェクトのコレクション(1 つまたは複数)。
戻り値
新たに作成された拡張 ACL オブジェクトのインスタンス名 ID。
createIpv6Acls
ネットワーク要素内に 1 つまたは複数の IPv6 ACL オブジェクトを作成します。ネットワーク要素の InstanceNameId および IPv6 ACL オブジェクトのリストを指定すると、サーバにこのオブジェクトを作成し、そのインスタンス名 ID を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• ipv6AclCol コレクションがヌル、またはこのコレクションが空である場合。
• ipv6AclCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションに Ipv6AccessControlList タイプではないオブジェクトが含まれている場合。
• Ipv6AccessControlEntry 内の Ipv6AccessControlList にシーケンス番号が含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• ipv6AclCol コレクションでは、Ipv6AccessControlList アトリビュートが 1 つも有効ではない、または IPv6 ACL 内の Ipv6AccessControlEntry が有効ではない場合。
例:
• ACL 名が数字で始まる。これは ACL 名にはスペースや引用符は使用できず、また番号付きアクセス リストとの混同を避けるために英字で始まらなければならないと決められているからです。
• ACL の remark アトリビュート値に 101 文字以上が含まれている。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• すでにデータベースに存在する Ipv6AccessControlList が ipv6AclCol に含まれている場合。
• ipv6AclCol 内の Ipv6AccessControlList に重複する Ipv6AccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。IPv6 ACL とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。IPv6 ACL をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
ipv6AclCol:作成が必要な IPv6 ACL オブジェクトのコレクション(1 つまたは複数)。
戻り値
新たに作成された IPv6 ACL オブジェクトのインスタンス名 ID。
createMacAcls
ネットワーク要素内に 1 つまたは複数の MAC ACL オブジェクトを作成します。ネットワーク要素の InstanceNameId および MAC ACL オブジェクトのリストを指定すると、サーバにこのオブジェクトを作成し、そのインスタンス名 ID を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• macAclCol コレクションがヌル、またはこのコレクションが空である場合。
• macAclCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションに MacAccessControlList タイプではないオブジェクトが含まれている場合。
• MacAccessControlList 内の MacAccessControlEntry にシーケンス番号が含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• macAclCol コレクションでは、MacAccessControlList アトリビュートが 1 つも有効ではない、または MAC ACL 内の MacAccessControlEntry が有効ではない場合。
例:
• ACL 名が数字で始まる。これは ACL 名にはスペースや引用符は使用できず、また番号付きアクセス リストとの混同を避けるために英字で始まらなければならないと決められているからです。
• ACL の remark アトリビュート値に 101 文字以上が含まれている。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• すでにデータベースに存在する MacAccessControlList が macAclCol に含まれている場合。
• macAclCol 内の MacAccessControlList に重複する MacAccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。MAC ACL とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。MAC ACL をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
macAclCol:作成が必要な MAC ACL オブジェクトのコレクション(1 つまたは複数)。
戻り値
新たに作成された MAC ACL オブジェクトのインスタンス名 ID。
createRbaclPolicies
ネットワーク要素内に 1 つまたは複数のロールベース ACL ポリシー オブジェクトを作成します。ネットワーク要素の InstanceNameId およびロールベース ACL ポリシー オブジェクトのリストを指定すると、サーバにこのオブジェクトを作成し、そのインスタンス名 ID を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• rbaclPolicyCol コレクションがヌル、またはこのコレクションが空である場合。
• rbaclPolicyCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションに RoleBasedAccessControlPolicy タイプではないオブジェクトが含まれている場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclPolicyCol コレクションでは、RoleBasedAccessControlPolicy アトリビュートが 1 つも有効ではない、またはロールベース ACL ポリシー内の RoleBasedAccessControlEntry が有効ではない場合。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• すでにデータベースに存在する RoleBasedAccessControlPolicy が rbaclPolicyCol に含まれている場合。
• rbaclPolicyCol 内の RoleBasedAccessControlPolicy に重複する要素が含まれている場合。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
rbaclPolicyCol:作成が必要な RoleBasedAccessControlPolicy オブジェクトのコレクション(1 つまたは複数)。
戻り値
新たに作成された RoleBasedAccessControlPolicy オブジェクトのインスタンス名 ID。
createRbacls
ネットワーク要素内に 1 つまたは複数の RBACL オブジェクトを作成します。ネットワーク要素の InstanceNameId および RBACL オブジェクトのリストを指定すると、サーバにこのオブジェクトを作成し、そのインスタンス名 ID を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• rbaclCol コレクションがヌル、またはこのコレクションが空である場合。
• rbaclCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションに RoleBasedAccessControlList タイプではないオブジェクトが含まれている場合。
• RoleBasedAccessControlList 内の RoleBasedAccessControlEntry にシーケンス番号が含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclCol コレクションでは、RoleBasedAccessControlList アトリビュートが 1 つも有効ではない、または RBACL 内の RoleBasedAccessControlEntry が有効ではない場合。
例:
• ACL 名が数字で始まる。これは ACL 名にはスペースや引用符は使用できず、また番号付きアクセス リストとの混同を避けるために英字で始まらなければならないと決められているからです。
• ACL の remark アトリビュート値に 101 文字以上が含まれている。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• すでにデータベースに存在する RoleBasedAccessControlList が rbaclCol に含まれている場合。
• rbaclCol 内の RoleBasedAccessControlList に重複する RoleBasedAccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。RBACL とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。RBACL をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
rbaclCol:作成が必要な RBACL オブジェクトのコレクション(1 つまたは複数)。
戻り値
新たに作成された RBACL オブジェクトのインスタンス名 ID。
createStandardIpAcls
ネットワーク要素内に 1 つまたは複数の標準 IP ACL オブジェクトを作成します。ネットワーク要素の InstanceNameId および StandardAccessControlList オブジェクトのリストを指定すると、サーバにこの StandardAccessControlList オブジェクトを作成し、戻します。
InstanceException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
ParameterException は、次のいずれかの状況が発生した場合にスローされます。
• standardIpAclCol コレクションがヌル、またはこのコレクションが空である場合。
• standardIpAclCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションに StandardAccessControlList タイプではないオブジェクトが含まれている場合。
• StandardAccessControlList 内の StandardAccessControlEntry にシーケンス番号が含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• standardIpAclCol コレクションでは、StandardAccessControlList アトリビュートが 1 つも有効ではない、または StandardAccessControlList 内の StandardAccessControlEntry が有効ではない場合。
例:
• ACL 名が数字で始まる。これは ACL 名にはスペースや引用符は使用できず、また番号付きアクセス リストとの混同を避けるために英字で始まらなければならないと決められているからです。
• ACL の remark 記述値に 101 文字以上が含まれている。
FeatureException は、次のいずれかの状況が発生した場合にスローされます。
• すでにデータベースに存在する StandardAccessControlList が standardIpAclCol に含まれている場合。
• standardIpAclCol 内の StandardAccessControlList に重複する StandardAccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。StandardAccessControlList とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。StandardAccessControlList をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
standardIpAclCol:データベースに作成される StandardAccessControlList オブジェクトのコレクション(1 つまたは複数)。
戻り値
新たに作成された StandardAccessControlList オブジェクト。
createTimeRanges
ネットワーク要素内に 1 つまたは複数の TimeRange オブジェクトを作成します。ネットワーク要素の InstanceNameId および TimeRange オブジェクトのリストを指定すると、サーバにオブジェクトを作成し、そのインスタンス名 ID を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• timerangeCol コレクションがヌル、またはこのコレクションが空である場合。
• timerangeCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションに TimeRange タイプではないオブジェクトが含まれている場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• timerangeCol コレクションでは、TimeRange アトリビュートが 1 つも有効ではない、または TimeRange 内の PeriodicTimeRange が有効ではない場合。
例:
• TimeRange の名前が数字で始まる。これは TimeRange 名にはスペースや引用符は使用できず、また番号付きアクセス リストとの混同を避けるために英字で始まらなければならないと決められているからです。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• すでにデータベースに存在する TimeRange が timerangeCol に含まれている場合。
• timerangeCol 内の TimeRange に重複する PeriodicTimeRange オブジェクトが含まれている場合。
この API は ACE アソシエーションを考慮しません。TimeRange とともに ACE アソシエーションが渡されても、この API では考慮されません。TimeRange を ACE にバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
timerangeCol:作成が必要な TimeRange オブジェクトのコレクション(1 つまたは複数)。
戻り値
新たに作成された TimeRange オブジェクトのインスタンス名 ID。
createVlanAccessMaps
ネットワーク要素内に 1 つまたは複数の VACL オブジェクトを作成します。ネットワーク要素の InstanceNameId および VACL オブジェクトのリストを指定すると、サーバにオブジェクトを作成し、そのインスタンス名 ID を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• vlanAccessMapEntryCol コレクションがヌル、またはこのコレクションが空である場合。
• vlanAccessMapEntryCol に 1 つまたは複数のヌル要素が含まれている、またはこのコレクションに VlanAccessMap タイプではないオブジェクトが含まれている場合。
• VlanAccessMap 内の VlanAccessMapEntry にシーケンス番号が含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapEntryCol コレクションでは、VlanAccessMap アトリビュートが 1 つも有効ではない、または VACL 内の VlanAccessMapEntry が有効ではない場合。
例:
• ACL 名が数字で始まる。これは ACL 名にはスペースや引用符は使用できず、また番号付きアクセス リストとの混同を避けるために英字で始まらなければならないと決められているからです。
• ACL の remark アトリビュート値に 101 文字以上が含まれている。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• すでにデータベースに存在する VlanAccessMap が vlanAccessMapEntryCol に含まれている場合。
• vlanAccessMapEntryCol 内の VlanAccessMap に重複する VlanAccessMapEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。VACL とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。VACL をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
vlanAccessMapCol:作成が必要な VACL オブジェクトのコレクション(1 つまたは複数)。
戻り値
新たに作成された VACL オブジェクトのインスタンス名 ID。
deleteExtendedIpAcls
1 つまたは複数の拡張 IP ACL オブジェクトを削除します。ExtendedAccessControlList オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• extendedIpAclInstanceNameIdCol コレクションがヌル、または空の場合。
• extendedIpAclInstanceNameIdCol コレクションに、ExtendedAccessControlList InstanceNameId タイプではない要素が含まれている場合。
• データベースに存在しない ExtendedAccessControlList が extendedIpAclInstanceNameIdCol コレクションに含まれている場合。
パラメータ
opContext:動作コンテキスト。
extendedIpAclInstanceNameIdCol:削除する必要のある 1 つまたは複数の ExtendedAccessControlList オブジェクトの InstanceNameId を含むコレクション。
戻り値
void
deleteIpv6Acls
1 つまたは複数の IPv6 ACL オブジェクトを削除します。Ipv6AccessControlList オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• ipv6AclInstanceNameIdCol コレクションがヌル、または空の場合。
• ipv6AclInstanceNameIdCol コレクションに、Ipv6AccessControlList InstanceNameId タイプではない要素が含まれている場合。
• データベースに存在しない Ipv6AccessControlList が ipv6AclInstanceNameIdCol コレクションに含まれている場合。
パラメータ
opContext:動作コンテキスト。
ipv6AclInstanceNameIdCol:削除する必要のある 1 つまたは複数の Ipv6AccessControlList オブジェクトの InstanceNameId を含むコレクション。
戻り値
void
deleteMacAcls
1 つまたは複数の MAC ACL オブジェクトを削除します。MacAccessControlList オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• macAclInstanceNameIdCol コレクションがヌル、または空の場合。
• macAclInstanceNameIdCol コレクションに、MacAccessControlList InstanceNameId タイプではない要素が含まれている場合。
• データベースに存在しない MacAccessControlList が macAclInstanceNameIdCol コレクションに含まれている場合。
パラメータ
opContext:動作コンテキスト。
macAclInstanceNameIdCol:削除する必要のある 1 つまたは複数の MacAccessControlList オブジェクトの InstanceNameId を含むコレクション。
戻り値
void
deleteRbaclPolicies
1 つまたは複数のロールベース ACL ポリシー オブジェクトを削除します。RoleBasedAccessControlPolicy オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclPolicyInstanceNameIdCol コレクションがヌル、または空の場合。
• rbaclPolicyInstanceNameIdCol コレクションに、RoleBasedAccessControlPolicy InstanceNameId タイプではない要素が含まれている場合。
• データベースに存在しない RoleBasedAccessControlPolicy が rbaclPolicyInstanceNameIdCol コレクションに含まれている場合。
パラメータ
opContext:動作コンテキスト。
rbaclPolicyInstanceNameIdCol:削除する必要のある 1 つまたは複数の RoleBasedAccessControlPolicy オブジェクトの InstanceNameId を含むコレクション。
戻り値
void
deleteRbacls
1 つまたは複数のロールベース ACL オブジェクトを削除します。RoleBasedAccessControlList オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclInstanceNameIdCol コレクションがヌル、または空の場合。
• rbaclInstanceNameIdCol コレクションに、RoleBasedAccessControlList InstanceNameId タイプではない要素が含まれている場合。
• データベースに存在しない RoleBasedAccessControlList が rbaclInstanceNameIdCol コレクションに含まれている場合。
パラメータ
opContext:動作コンテキスト。
rbaclInstanceNameIdCol:削除する必要のある 1 つまたは複数の RoleBasedAccessControlList オブジェクトの InstanceNameId を含むコレクション。
戻り値
void
deleteStandardIpAcls
1 つまたは複数の標準 IP ACL オブジェクトを削除します。StandardAccessControlList オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。
ParameterException は、次のいずれかの状況が発生した場合にスローされます。
• standardIpAclInstanceNameIdCol コレクションがヌル、または空の場合。
• standardIpAclInstanceNameIdCol コレクションに、StandardAccessControlList InstanceNameId タイプではない要素が含まれている場合。
• データベースに存在しない StandardAccessControlList が standardIpAclInstanceNameIdCol コレクションに含まれている場合。
パラメータ
opContext:動作コンテキスト。
standardIpAclInstanceNameIdCol:削除する必要のある 1 つまたは複数の StandardAccessControlList オブジェクトの InstanceNameId を含むコレクション。
戻り値
void
deleteTimeRanges
1 つまたは複数の TimeRange オブジェクトを削除します。TimeRange オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• timerangeInstanceNameIdCol コレクションがヌル、または空の場合。
• timerangeInstanceNameIdCol コレクションに、TimeRange InstanceNameId タイプではない要素が含まれている場合。
• データベースに存在しない TimeRange が timerangeInstanceNameIdCol コレクションに含まれている場合。
パラメータ
opContext:動作コンテキスト。
timerangeInstanceNameIdCol:削除する必要のある 1 つまたは複数の TimeRange オブジェクトの InstanceNameId を含むコレクション。
戻り値
void
deleteVlanAccessMaps
1 つまたは複数の VACL オブジェクトを削除します。VlanAccessMap オブジェクトの InstanceNameId を指定すると、これらのオブジェクトがサーバから削除されます。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapEntryInstanceNameIdCol コレクションがヌル、または空の場合。
• vlanAccessMapEntryInstanceNameIdCol コレクションに、VlanAccessMap InstanceNameId タイプではない要素が含まれている場合。
• データベースに存在しない VlanAccessMap が vlanAccessMapEntryInstanceNameIdCol コレクションに含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapInstanceNameIdCol:削除する必要のある 1 つまたは複数の VlanAccessMap オブジェクトの InstanceNameId を含むコレクション。
戻り値
void
getAssociatedVlanAccessMap
VLAN に関連付けられている VlanAccessMap を戻します。ネットワーク要素 InstanceNameId、およびこのネットワーク要素の VLAN ID を指定すると、この VLAN に関連付けられている VlanAccessMap オブジェクトを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
vlanId:VLAN の ID。
戻り値
指定された VLAN ID を持つ VLAN に関連付けられている VlanAccessMap オブジェクト。戻された VlanAccessMap オブジェクトには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された VlanAccessMap オブジェクト内の関連する VlanAccessMapEntry すべて。
• もし、VlanAccessMap にあれば、各 VlanAccessMapEntry に関連付けられている IP ACL/MAC ACL/IPv6 ACL オブジェクト(これらの ACL は VlanAccessMapEntry で一致条件として使用されるため)。IP/MAC/IPv6 ACLs では、VlanAccessMapEntry のアソシエーションを除き、すべてのアソシエーションが削除されます。
• リダイレクト インターフェイスとして、各 VlanAccessMapEntry と関連付けられている NetworkInterface オブジェクト(ある場合)。ネットワーク インターフェイスでは、VlanAccessMapEntry アソシエーションを除き、すべてのアソシエーションが削除されます。
この VLAN に関連付けられている VlanAccessMap が存在しなければ、ヌルが戻されます。
getExtendedIpAclToNetworkInterfaceAssociationsInNetworkElement
すべての ExtendedAccessControlList オブジェクトを、ネットワーク要素で設定された NetworkInterface アソシエーションに戻します。ネットワーク要素の InstanceNameId を指定すると、ExtendedAccessControlList のコレクションを NetworkInterface アソシエーション オブジェクトに戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
AclAppliesToNetworkInterface オブジェクトのリスト。これは ExtendedAccessControlList と NetworkInterface の間のアソシエーションを表します。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• ExtendedAccessControlList オブジェクト。ACL オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
• NetworkInterface オブジェクト。NetworkInterface オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
getExtendedIpAcls
InstanceNameId から ExtendedAccessControlList オブジェクトを戻します。ExtendedAccessControlList の InstanceNameId のコレクションを指定すると、対応する ExtendedAccessControlList オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• extendedIpAclInstanceNameIdCol がヌル、または空の場合。
• extendedIpAclInstanceNameIdCol に ExtendedAccessControlList の無効な InstanceNameId が含まれる場合。
• extendedIpAclInstanceNameIdCol にヌル値が含まれる場合。
• extendedIpAclInstanceNameIdCol に、特定の InstanceNameId を持つ同等の ExtendedAccessControlList オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
extendedIpAclInstanceNameIdCol:ExtendedAccessControlList の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する ExtendedAccessControlList オブジェクトのリスト。戻された ExtendedAccessControlList オブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• ExtendedAccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getExtendedIpAclsInNetworkElement
ネットワーク要素内のすべての ExtendedAccessControlList オブジェクトを戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の ExtendedAccessControlList オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
ExtendedAccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• ExtendedAccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getExtendedNamedIpAclsInNetworkElement
ネットワーク要素内の名前付き ExtendedAccessControlList オブジェクトをすべて戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の名前で一意に識別できる ExtendedAccessControlList オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
名前付き ExtendedAccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• ExtendedAccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。この TimeRange が PeriodicTimeRange エントリなど、その他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getExtendedNumberedIpAclsInNetworkElement
ネットワーク要素内の番号付き ExtendedAccessControlList オブジェクトをすべて戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の番号で一意に識別できる ExtendedAccessControlList オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
番号付き ExtendedAccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• ExtendedAccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getIpAclToNetworkInterfaceAssociationsInNetworkElement
すべての IP ACL(IPv4 ACL および IPv6 ACL)を、ネットワーク要素で設定されたネットワーク インターフェイス アソシエーションに戻します。ネットワーク要素のインスタンス名 ID を指定すると、IP ACL のコレクションをネットワーク インターフェイス アソシエーション オブジェクトに戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
AclAppliesToNetworkInterface オブジェクトのリスト。これは標準 ACL、拡張 ACL、または IPv6 ACL と NetworkInterface の間のアソシエーションを表します。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• StandardAccessControlList、ExtendedAccessControlList、または Ipv6AccessControlList オブジェクト。ACL オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
• NetworkInterface オブジェクト。NetworkInterface オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
getIpAclsInNetworkElement
あるネットワーク要素で設定されているすべての IP ACL(IPv4 ACL および IPv6 ACL)を戻します。このネットワーク要素の InstanceNameId を指定すると、IP ACL オブジェクトのコレクションを戻します。
InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
StandardAccessControlList、ExtendedAccessControlList、および Ipv6AccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• 戻された ACL オブジェクトの関連する remark すべて。
• ExtendedAccessControlListo および Ipv6AccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
戻される ACL は、ACL の名前または番号順に並べられます。
getIpv4AclToNetworkInterfaceAssociationsInNetworkElement
すべての IPv4 ACL(StandardAccessControlList オブジェクトと ExtendedAccessControlList オブジェクトの両方)を、ネットワーク要素で設定された NetworkInterface アソシエーションに戻します。ネットワーク要素の InstanceNameId を指定すると、IPv4 ACL のコレクションを NetworkInterface アソシエーション オブジェクトに戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
AclAppliesToNetworkInterface オブジェクトのリスト。これは標準 ACL または拡張 ACL と NetworkInterface の間のアソシエーションを表します。NetworkInterface。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• StandardAccessControlList、または ExtendedAccessControlList オブジェクト。ACL オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
• NetworkInterface オブジェクト。NetworkInterface オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
getIpv4Acls
InstanceNameId から IPv4 ACL(StandardAccessControlList オブジェクトおよび ExtendedAccessControlList オブジェクトの両方)を戻します。StandardAccessControlList および ExtendedAccessControlList の InstanceNameId のコレクションを指定すると、対応する StandardAccessControlList オブジェクト、および ExtendedAccessControlList オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• ipv4AclInstanceNameIdCol がヌル、または空の場合。
• ipv4AclInstanceNameIdCol に StandardAccessControlList または ExtendedAccessControlList の無効な InstanceNameId が含まれる場合。
– ヌル値。
• ipv4AclInstanceNameIdCol に、特定の InstanceNameId を持つ同等の IPv4 ACL オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
ipv4AclInstanceNameIdCol:StandardAccessControlList および ExtendedAccessControlList の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する StandardAccessControlList および ExtendedAccessControlList オブジェクトのリスト。戻された IPv4 ACL オブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• ExtendedAccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getIpv4AclsInNetworkElement
あるネットワーク要素で設定されているすべての IPv4 ACL(標準 ACL および拡張 ACL)を戻します。このネットワーク要素の InstanceNameId を指定すると、IP ACL オブジェクトのコレクションを戻します。
InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
StandardAccessControlList、ExtendedAccessControlList、および Ipv6AccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• 戻された ACL オブジェクトの関連する remark すべて。
• ExtendedAccessControlListo および Ipv6AccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
戻される ACL は、ACL の名前または番号順に並べられます。
getIpv4AclsWithoutAcesInNetworkElement
あるネットワーク要素で設定されているすべての IPv4 ACL(標準 ACL および拡張 ACL)を戻します。このネットワーク要素の InstanceNameId を指定すると、IP ACL オブジェクトのコレクションを戻します。
InstanceException は、渡された引数 neInstanceNameId がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
StandardAccessControlList、ExtendedAccessControlList、および Ipv6AccessControlList オブジェクトのリスト。戻されたオブジェクト リストでは、すべてのアソシエーションがクリアされます。戻される ACL は、ACL の名前または番号順に並べられます。
getIpv6AclToNetworkInterfaceAssociationsInNetworkElement
すべての Ipv6AccessControlList オブジェクトを、ネットワーク要素で設定された NetworkInterface アソシエーションに戻します。ネットワーク要素の InstanceNameId を指定すると、Ipv6AccessControlList のコレクションを NetworkInterface アソシエーション オブジェクトに戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
AclAppliesToNetworkInterface オブジェクトのリスト。これは Ipv6AccessControlList と NetworkInterface の間のアソシエーションを表します。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• Ipv6AccessControlList オブジェクト。ACL オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
• NetworkInterface オブジェクト。NetworkInterface オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
getIpv6Acls
InstanceNameId から Ipv6AccessControlList オブジェクトを戻します。Ipv6AccessControlList の InstanceNameId のコレクションを指定すると、対応する Ipv6AccessControlList オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• ipv6AclInstanceNameIdCol がヌル、または空の場合。
• ipv6AclInstanceNameIdCol に Ipv6AccessControlList の無効な InstanceNameId が含まれる場合。
• ipv6AclInstanceNameIdCol にヌル値が含まれる場合。
• ipv6AclInstanceNameIdCol に、特定の InstanceNameId を持つ同等の Ipv6AccessControlList オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
ipv6AclInstanceNameIdCol:Ipv6AccessControlList の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する Ipv6AccessControlList オブジェクトのリスト。戻された Ipv6AccessControlList オブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• Ipv6AccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getIpv6AclsInNetworkElement
ネットワーク要素内のすべての IPv6 ACL を戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の IPv6 ACL オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
Ipv6AccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• Ipv6AccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getIpv6AclsWithoutAcesInNetworkElement
ネットワーク要素内のすべての IPv6 ACL を戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の IPv6 ACL オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
Ipv6AccessControlList オブジェクトのリスト。戻されたオブジェクト リストでは、すべてのアソシエーションがクリアされます。
getMacAclToNetworkInterfaceAssociationsInNetwork
Element
すべての MAC ACL を、ネットワーク要素で設定されたネットワーク インターフェイス アソシエーションに戻します。ネットワーク要素のインスタンス名 ID を指定すると、MAC ACL のコレクションをネットワーク インターフェイス アソシエーション オブジェクトに戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
AclAppliesToNetworkInterface オブジェクトのリスト。これは MAC ACL とネットワーク インターフェイスの間のアソシエーションを表します。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• MacAccessControlList オブジェクト。ACL オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
• NetworkInterface オブジェクト。ネットワーク インターフェイス オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
getMacAcls
InstanceNameId から MacAccessControlList オブジェクトを戻します。MacAccessControlList の InstanceNameId のコレクションを指定すると、対応する MacAccessControlList オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• macAclInstanceNameIdCol がヌル、または空の場合。
• macAclInstanceNameIdCol に MacAccessControlList の無効な InstanceNameId が含まれる場合。
• macAclInstanceNameIdCol にヌル値が含まれる場合。
• macAclInstanceNameIdCol に、特定の InstanceNameId を持つ同等の MacAccessControlList オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
macAclInstanceNameIdCol:MacAccessControlList の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する MacAccessControlList オブジェクトのリスト。戻された MacAccessControlList オブジェクト リストには、戻された MacAccessControlList と関連付けられている MacAccessControlEntrys のみが存在します。その他のアソシエーションはすべてクリアされます。
getMacAclsInNetworkElement
ネットワーク要素内のすべての MacAccessControlList オブジェクトを戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の MacAccessControlList オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
MacAccessControlList オブジェクトのリスト。戻された MacAccessControlList オブジェクト リストには、戻された MacAccessControlList と関連付けられている MAC ACEs のみが存在します。その他のアソシエーションはすべてクリアされます。
getMacAclsWithoutAcesInNetworkElement
ネットワーク要素内のすべての MacAccessControlList オブジェクトを戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の MacAccessControlList オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
MacAccessControlList オブジェクトのリスト。戻された MacAccessControlList オブジェクト リストでは、すべてのアソシエーションがクリアされます。
getNamedIpv4AclsInNetworkElement
ネットワーク要素内の名前付き IPv4 ACL(StandardAccessControlList オブジェクトと ExtendedAccessControlList オブジェクトの両方)をすべて戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の名前で一意に識別できる IPv4 ACL のコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
名前付き StandardAccessControlList および ExtendedAccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• ExtendedAccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getNumberedIpv4AclsInNetworkElement
ネットワーク要素内の番号付き IPv4 ACL(StandardAccessControlList と ExtendedAccessControlList の両方)オブジェクトをすべて戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の番号で一意に識別できる IPv4 ACL のコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
番号付き StandardAccessControlList および ExtendedAccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• ExtendedAccessControlList 内に ACE があれば、個々の ACE に対する TimeRange アソシエーション。PeriodicTimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getRbaclPolicies
InstanceNameId から RBACL ポリシーを戻します。RoleBasedAccessControlPolicy の InstanceNameId のコレクションを指定すると、対応する RBACL ポリシー オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclPolicyInstanceNameIdCol がヌル、または空の場合。
• rbaclPolicyInstanceNameIdCol に無効なロールベース ACL InstanceNameId、またはヌル値が含まれている場合。
• rbaclPolicyInstanceNameIdCol に、特定の InstanceNameId を持つ同等の RBACL ポリシー オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
rbaclPolicyInstanceNameIdCol:RoleBasedAccessControlPolicy の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する RoleBasedAccessControlPolicy オブジェクトのリスト。戻された RBACL ポリシー オブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 関連する RoleBasedAccessControlList オブジェクトすべて。RBACL オブジェクトでは、RBACL ポリシーのアソシエーションを除き、すべてのアソシエーションが削除されます。
getRbaclPoliciesInNetworkElement
ネットワーク要素内のロールベース ACL ポリシーをすべて戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内のロールベース ACL ポリシーのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
RoleBasedAccessControlPolicy オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 関連する RoleBasedAccessControlList オブジェクトすべて。RBACL オブジェクトでは、RBACL ポリシーのアソシエーションを除き、すべてのアソシエーションが削除されます。
getRbacls
InstanceNameId からロールベース ACL を戻します。RoleBasedAccessControlList の InstanceNameId のコレクションを指定すると、対応するロールベース ACL オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclInstanceNameIdCol がヌル、または空の場合。
• rbaclInstanceNameIdCol に無効なロールベース ACL InstanceNameId、またはヌル値が含まれている場合。
• rbaclInstanceNameIdCol に、特定の InstanceNameId を持つ同等のロールベース ACL オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
rbaclInstanceNameIdCol:RoleBasedAccessControlList の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する RoleBasedAccessControlList オブジェクトのリスト。戻されたロールベース ACL オブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• RoleBasedAccessControlList 内に ACE があれば、個々の ACE に対する Timerange アソシエーション。定期的な TimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getRbaclsInNetworkElement
ネットワーク要素内のロールベース ACL をすべて戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内のロールベース ACL のコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
RoleBasedAccessControlList オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された ACL オブジェクト内の関連する ACE すべて。
• RoleBasedAccessControlList 内に ACE があれば、個々の ACE に対する Timerange アソシエーション。定期的な TimeRange エントリなど、この TimeRange がその他のアソシエーションを持っている場合、これらのアソシエーションはクリアされます。
getStandardIpAclToNetworkInterfaceAssociationsInNetworkElement
すべての StandardAccessControlList オブジェクトを、ネットワーク要素で設定された NetworkInterface アソシエーションに戻します。ネットワーク要素の InstanceNameId を指定すると、StandardAccessControlList のコレクションを NetworkInterface アソシエーション オブジェクトに戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
AclAppliesToNetworkInterface オブジェクトのリスト。これは StandardAccessControlList と NetworkInterface の間のアソシエーションを表します。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• StandardAccessControlList オブジェクト。ACL オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
• NetworkInterface オブジェクト。ネットワーク インターフェイス オブジェクトでは、AclAppliesToNetworkInterface アソシエーションを除き、すべてのアソシエーションがクリアされます。
getStandardIpAcls
InstanceNameId から StandardAccessControlList オブジェクトを戻します。StandardAccessControlList の InstanceNameId のコレクションを指定すると、対応する StandardAccessControlList オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• standardIpAclInstanceNameIdCol がヌル、または空の場合。
• standardIpAclInstanceNameIdCol に StandardAccessControlList の無効な InstanceNameId が含まれる場合。
• standardIpAclInstanceNameIdCol コレクションにヌル値が含まれる場合。
• standardIpAclInstanceNameIdCol に、特定の InstanceNameId を持つ同等の StandardAccessControlList オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
standardIpAclInstanceNameIdCol:StandardAccessControlList の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する StandardAccessControlList オブジェクトのリスト。戻された StandardAccessControlList オブジェクト リストには、戻された StandardAccessControlList オブジェクトと関連付けられている StandardAccessControlEntry オブジェクトのみが存在します。その他のアソシエーションはすべてクリアされます。
getStandardIpAclsInNetworkElement
ネットワーク要素内のすべての StandardAccessControlList オブジェクトを戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の StandardAccessControlList オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
StandardAccessControlList オブジェクトのリスト。戻された StandardAccessControlList オブジェクト リストには、戻された StandardAccessControlList と関連付けられている Standard ACE のみが存在します。その他のアソシエーションはすべてクリアされます。
getStandardNamedIpAclsInNetworkElement
ネットワーク要素内の名前付き StandardAccessControlList オブジェクトをすべて戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の名前で一意に識別できる StandardAccessControlList オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
名前付き StandardAccessControlList オブジェクトのリスト。戻された名前付き StandardAccessControlList オブジェクト リストには、戻された StandardAccessControlList と関連付けられている Standard ACE のみが存在します。その他のアソシエーションはすべてクリアされます。
getStandardNumberedIpAclsInNetworkElement
ネットワーク要素内の番号付き StandardAccessControlList オブジェクトをすべて戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の番号で一意に識別できる StandardAccessControlList オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または AbstractNetworkElement の有効な InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
番号付き StandardAccessControlList オブジェクトのリスト。戻された番号付き StandardAccessControlList オブジェクト リストには、戻された StandardAccessControlList オブジェクトと関連付けられている StandardAccessControlEntry オブジェクトのみが存在します。その他のアソシエーションはすべてクリアされます。
getTimeRanges
InstanceNameId から TimeRanges オブジェクトを戻します。TimeRanges の InstanceNameId のコレクションを指定すると、対応する TimeRanges オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• timerangeInstanceNameIdCol がヌル、または空の場合。
• timerangeInstanceNameIdCol に無効な拡張 ACL InstanceNameId、またはヌル値が含まれている場合。
• timerangeInstanceNameIdCol に、特定の InstanceNameId を持つ同等の TimeRange オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
timerangeInstanceNameIdCol:TimeRange の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する TimeRange オブジェクトのリスト。戻された TimeRange オブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 関連する定期的 TimeRange エントリすべて。
• 絶対 TimeRange エントリ。
getTimeRangesInNetworkElement
ネットワーク要素内のすべての TimeRanges オブジェクトを戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の TimeRanges オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
TimeRanges オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 関連する定期的 TimeRange エントリすべて。
• 絶対 TimeRange エントリ。
getTimeRangesWithoutEntriesInNetworkElement
ネットワーク要素内のすべての TimeRanges オブジェクトを戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の TimeRanges オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
TimeRanges オブジェクトのリスト。戻されたオブジェクト リストでは、すべてのアソシエーションがクリアされます。
getVlanAccessLogSettingInNetworkElements
ネットワーク要素に適用されている VACL ログ設定を戻します。ネットワーク要素の InstanceNameId のコレクションを指定すると、これらのネットワーク要素に適用されている VACL ログ設定を戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameIdCol がヌル、または空の場合。
• neInstanceNameIdCol に無効なネットワーク要素 InstanceNameId、またはヌル値が含まれている場合。
• neInstanceNameIdCol に特定の InstanceNameId を持つ、同等のネットワーク要素オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
neInstanceNameIdCol:ネットワーク要素の InstanceNameId のコレクション。
戻り値
ネットワーク要素の InstanceNameId に対応する VlanAccessLog オブジェクトのリスト。
getVlanAccessMaps
InstanceNameId から VACL を戻します。VlanAccessMap の InstanceNameId のコレクションを指定すると、対応する VACL オブジェクトを戻します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapEntryInstanceNameIdCol がヌル、または空の場合。
• vlanAccessMapEntryInstanceNameIdCol に無効な VACL InstanceNameId、またはヌル値が含まれている場合。
• vlanAccessMapEntryInstanceNameIdCol に、特定の InstanceNameId を持つ同等の VACL オブジェクトが存在しない場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapInstanceNameIdCol:VlanAccessMap の InstanceNameId のコレクション。
戻り値
指定された InstanceNameId のコレクションに対応する VlanAccessMap オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された VACL オブジェクト内の関連する VACE すべて。
• もし、VlanAccessMap にあれば、各 VACE に関連付けられている IP ACL/MAC ACL/IPv6 ACL オブジェクト(これらの ACL は VACE で一致条件として使用されるため)。IP/MAC/IPv6 ACLs では、VACE のアソシエーションを除き、すべてのアソシエーションが削除されます。
• リダイレクト インターフェイスとして、各 VACE と関連付けられている NetworkInterface オブジェクト(ある場合)。ネットワーク インターフェイスでは、VACE アソシエーションを除き、すべてのアソシエーションが削除されます。
getVlanAccessMapsInNetworkElement
ネットワーク要素内のすべての VLAN ACL を戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の VLAN ACL オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
VlanAccessMap オブジェクトのリスト。戻されたオブジェクト リストには、次のアソシエーションのみが存在します。その他のアソシエーションはすべてクリアされます。
• 戻された VACL オブジェクト内の関連する VACE すべて。
• もし、VlanAccessMap にあれば、各 VACE に関連付けられている IP ACL/MAC ACL/IPv6 ACL オブジェクト(これらの ACL は VACE で一致条件として使用されるため)。IP/MAC/IPv6 ACLs では、VACE のアソシエーションを除き、すべてのアソシエーションが削除されます。
• リダイレクト インターフェイスとして、各 VACE と関連付けられている NetworkInterface オブジェクト(ある場合)。ネットワーク インターフェイスでは、VACE アソシエーションを除き、すべてのアソシエーションが削除されます。
getVlanAccessMapsWithoutVlanAccessMapEntriesInNetworkElement
ネットワーク要素内のすべての VLAN ACL を戻します。ネットワーク要素の InstanceNameId を指定すると、このネットワーク要素内の VLAN ACL オブジェクトのコレクションを戻します。
ValidationException は、渡された引数がヌルの場合、または有効なネットワーク要素 InstanceNameId ではない場合にスローされます。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
戻り値
VlanAccessMap オブジェクトのリスト。戻されたオブジェクト リストでは、すべてのアソシエーションがクリアされます。
modifyAclSequence
開始シーケンス番号およびシーケンス番号の増分ステップに基づいて、ACL 内の ACE のシーケンス番号を変更します。
パラメータ
opContext:動作コンテキスト。
aclInstanceNameIdCol:1 つまたは複数の ACL の InstanceNameId。
プラットフォーム タイプが Nexus 7000 シリーズ スイッチである場合、ACL のタイプは次のいずれかです。
– StandardAccessControlList
– ExtendedAccessControlList
– MacAccessControlList
– Ipv6AccessControlList
– RoleBasedAccessControlList
プラットフォーム タイプが Catalyst 6500 シリーズ スイッチである場合、ACL のタイプは次のいずれかです。
– StandardAccessControlList
– ExtendedAccessControlList
startSeqNo:アクセス リストのエントリは、この初期値を使用して、並べ直されます。
increment:シーケンス番号の変更量を示す数値。たとえば、increment 値が 5 で開始シーケンス番号が 20 の場合、以降のシーケンス番号は 25、30、35、40 と続きます。
戻り値
void
modifyExtendedIpAcls
既存の拡張 IP ACL オブジェクトを 1 つまたは複数、変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• extendedIpAclCol コレクションがヌル、または空の場合。
• extendedIpAclCol コレクションに、ExtendedAccessControlList タイプではないオブジェクトが含まれている場合。
• ExtendedAccessControlList 内の ExtendedAccessControlEntry にシーケンス番号が 1 つも含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• extendedIpAclCol コレクションでは、ExtendedAccessControlList 内のアトリビュートが 1 つも有効ではない、または拡張 ACL 内の ExtendedAccessControlEntry がいずれも有効ではない場合。
例:
• ACE の seqNo が範囲外である。
• ACL の remark アトリビュート値に 101 文字以上が含まれている。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• データベースに存在しない ExtendedAccessControlList が extendedIpAclCol コレクションに含まれている場合。
• extendedIpAclCol 内の ExtendedAccessControlList に重複する ExtendedAccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。拡張 ACL とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。拡張 ACL をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
extendedIpAclCol:データベース内の既存の ExtendedAccessControlList オブジェクトを置き換える ExtendedAccessControlList オブジェクトのコレクション(1 つまたは複数)。
戻り値
void
modifyIpv6Acls
既存の IPv6 ACL オブジェクトを 1 つまたは複数、変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• ipv6AclCol コレクションがヌル、または空の場合。
• ipv6AclCol コレクションに、Ipv6AccessControlList タイプではないオブジェクトが含まれている場合。
• Ipv6AccessControlList 内の Ipv6AccessControlEntry にシーケンス番号が 1 つも含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• ipv6AclCol コレクションでは、Ipv6AccessControlList 内のアトリビュートが 1 つも有効ではない、または IPv6 ACL 内の Ipv6AccessControlEntry がいずれも有効ではない場合。
例:
• ACE の seqNo が範囲外である。
• ACL の remark アトリビュート値に 101 文字以上が含まれている。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• データベースに存在しない Ipv6AccessControlList が ipv6AclCol コレクションに含まれている場合。
• ipv6AclCol 内の Ipv6AccessControlList に重複する Ipv6AccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。IPv6 ACL とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。IPv6 ACL をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
ipv6AclCol:データベース内の既存の Ipv6AccessControlList オブジェクトを置き換える Ipv6AccessControlList オブジェクトのコレクション(1 つまたは複数)。
戻り値
void
modifyMacAcls
既存の MAC ACL オブジェクトを 1 つまたは複数、変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• macAclCol コレクションがヌル、または空の場合。
• macAclCol コレクションに、MacAccessControlList タイプではないオブジェクトが含まれている場合。
• MacAccessControlEntry 内の MacAccessControlEntry にシーケンス番号が 1 つも含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• macAclCol コレクションでは、MacAccessControlList 内のアトリビュートが 1 つも有効ではない、または MAC ACL 内の MacAccessControlEntry がいずれも有効ではない場合。
例:
• ACE の seqNo が範囲外である。
• MAC ACL はすべて名前により識別されるため、MAC ACL に対して数値アトリビュートが設定されています。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• データベースに存在しない MacAccessControlList が macAclCol コレクションに含まれている場合。
• macAclCol 内の MacAccessControlList に重複する MacAccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。MAC ACL とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。MAC ACL をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
macAclCol:データベース内の既存の MacAccessControlList オブジェクトを置き換える MacAccessControlList オブジェクトのコレクション(1 つまたは複数)。
戻り値
void
modifyRbaclPolicies
既存の RBACL ポリシー オブジェクトを 1 つまたは複数、変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclPoliyCol コレクションがヌル、または空の場合。
• rbaclPoliyCol コレクションに、RoleBasedAccessControlPolicy タイプではないオブジェクトが含まれている場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclPoliyCol コレクションでは、RoleBasedAccessControlPolicy のアトリビュートが 1 つも有効ではない場合。
例:
• srcTagType は RoleBasedAccessControlPolicy では指定されていません。
• sgt は RoleBasedAccessControlPolicy では指定されていません。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• データベースに存在しない RoleBasedAccessControlPolicy が rbaclPoliyCol コレクションに含まれている場合。
• rbaclPoliyCol コレクションに重複する RoleBasedAccessControlPolicy オブジェクトが含まれる場合。
パラメータ
opContext:動作コンテキスト。
rbaclPoliyCol:データベース内の既存の RoleBasedAccessControlPolicy オブジェクトを置き換える RoleBasedAccessControlPolicy オブジェクトのコレクション(1 つまたは複数)。
戻り値
void
modifyRbacls
既存のロールベース ACL オブジェクトを 1 つまたは複数、変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclCol コレクションがヌル、または空の場合。
• rbaclCol コレクションに、RoleBasedAccessControlList タイプではないオブジェクトが含まれている場合。
• RoleBasedAccessControlList 内の RoleBasedAccessControlEntry にシーケンス番号が 1 つも含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• rbaclCol コレクションでは、RoleBasedAccessControlList 内のアトリビュートが 1 つも有効ではない、またはロールベース ACL 内の RoleBasedAccessControlEntry がいずれも有効ではない場合。
例:
• ACE の seqNo が範囲外である。
• ACL の remark アトリビュート値に 101 文字以上が含まれている。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• データベースに存在しない RoleBasedAccessControlList が rbaclCol コレクションに含まれている場合。
• rbaclCol 内の RoleBasedAccessControlList に重複する RoleBasedAccessControlEntry オブジェクトが含まれている場合。
パラメータ
opContext:動作コンテキスト。
rbaclCol:データベース内の既存の RoleBasedAccessControlList オブジェクトを置き換える RoleBasedAccessControlList オブジェクトのコレクション(1 つまたは複数)。
戻り値
void
modifyStandardIpAcls
既存の StandardAccessControlList オブジェクトを 1 つまたは複数、変更します。
ParameterException は、次のいずれかの状況が発生した場合にスローされます。
• standardIpAclCol コレクションがヌル、または空の場合。
• standardIpAclCol コレクションに、StandardAccessControlList タイプではないオブジェクトが含まれている場合。
• StandardAccessControlList 内の StandardAccessControlEntry にシーケンス番号が 1 つも含まれていない場合。
• データベースに存在しない StandardAccessControlList が standardIpAclCol コレクションに含まれている場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• standardIpAclCol コレクションでは、StandardAccessControlList 内のアトリビュートが 1 つも有効ではない、または標準 ACL 内の StandardAccessControlEntry がいずれも有効ではない場合。
例:
• ACE の seqNo が範囲外である。
• ACL の remark 記述値に 101 文字以上が含まれている。
FeatureCompoundException は、次のいずれかの状況が発生した場合にスローされます。
• standardIpAclCol 内の StandardAccessControlList に重複する StandardAccessControlEntry オブジェクトが含まれている場合。
この API はインターフェイス アソシエーションを考慮しません。StandardAccessControlList とともにインターフェイス アソシエーションが渡されても、この API では考慮されません。StandardAccessControlList をインターフェイスにバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
standardIpAclCol:データベース内の既存の StandardAccessControlList オブジェクトを置き換える StandardAccessControlList オブジェクトのコレクション(1 つまたは複数)。
戻り値
void
modifyTimeRanges
既存の TimeRange オブジェクトを 1 つまたは複数、変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• timerangeCol コレクションがヌル、または空の場合。
• TimeRange コレクションに、TimeRange タイプではないオブジェクトが含まれている場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• timerangeCol コレクションでは、TimeRange 内のアトリビュートが 1 つも有効ではない、または、TimeRange 内の PeriodicTimeRange もしくは AbsoluteTimeRange が 1 つも有効ではない場合。
例:
• startTime と endTime の両方が AbsoluteTimeRange で設定されていない。
• AbsoluteTimeRange または PeriodicTimeRange で、endTime が startTime よりも大きくない。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• データベースに存在しない TimeRange が timerangeCol コレクションに含まれている場合。
• timerangeCol 内の TimeRange に重複する PeriodicTimeRange オブジェクトが含まれている場合。
この API は ACE アソシエーションを考慮しません。TimeRange とともに ACE アソシエーションが渡されても、この API では考慮されません。TimeRange を ACE にバインドするには、別の API を呼び出す必要があります。
パラメータ
opContext:動作コンテキスト。
timerangeCol:データベース内の既存の TimeRange オブジェクトを置き換える TimeRange オブジェクトのコレクション(1 つまたは複数)。
戻り値
void
modifyVlanAccessLogSetting
ネットワーク要素内の VACL ログ オブジェクトを変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌルの場合。
• neInstanceNameId がネットワーク要素の有効な InstanceNameId ではない場合。
• vlanAccessMapEntryLog がヌルの場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapEntryLog では、アトリビュートのいずれかが無効である場合。
例:
• VlanAccessLog の maxFlow が範囲外である。
• VlanAccessLog の rateLimit が範囲外である。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:ネットワーク要素の InstanceNameId。
vlanAccessLog:データベース内の既存の VlanAccessLog オブジェクトを置き換える VlanAccessLog オブジェクト。
戻り値
void
modifyVlanAccessMaps
既存の VACL オブジェクトを 1 つまたは複数、変更します。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapEntryCol コレクションがヌル、または空の場合。
• vlanAccessMapEntryCol コレクションに、VlanAccessMap タイプではないオブジェクトが含まれている場合。
• VlanAccessMap 内の VlanAccessMapEntry のいずれにもシーケンス番号が含まれていない場合。
PropertiesException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapEntryCol コレクションでは、VlanAccessMap 内のアトリビュートが 1 つも有効ではない、または VACL 内の VlanAccessMapEntry がいずれも有効ではない場合。
例:
• VlanAccessMapEntry の seqNo が範囲外である。
• VlanAccessMapEntry のいずれの一致条件でも IP ACL、MAC ACL、または IPv6 ACL が指定されていません。
IntegrityException は、次のいずれかの状況が発生した場合にスローされます。
• データベースに存在しない VlanAccessMap が vlanAccessMapEntryCol コレクションに含まれている場合。
• vlanAccessMapEntryCol 内の VlanAccessMap に重複する VlanAccessMapEntry オブジェクトが含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapCol:データベース内の既存の VlanAccessMap オブジェクトを置き換える VlanAccessMap オブジェクトのコレクション(1 つまたは複数)。
戻り値
void
unbindIpv4AclFromNetworkInterface
ネットワーク インターフェイスから IPv4 ACL アソシエーションを指定された方向にクリアします。
ParameterException は、次のいずれかの状況が発生した場合にスローされます。
• networkInterfaceInstanceNameId がヌルである、またはこれが NetworkInterface オブジェクトの有効な InstanceNameId ではない場合。
• direction がヌルの場合。
パラメータ
opContext:動作コンテキスト。
networkInterfaceInstanceNameId:削除する必要のある ACL が含まれている NetworkInterface オブジェクトの InstanceNameId。
direction:StandardAccessControlList または ExtendedAccessControlList オブジェクトを削除する必要のある方向。
戻り値
void
unbindIpv4AclsFromVlanAccessMapEntry
VACE から指定された IPv4 ACL のリストをクリアします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapInstanceNameId がヌル、または VlanAccessMapEntry InstanceNameId タイプではない場合。
• vlanAccessMapInstanceNameId が有効な VlanAccessMapEntry InstanceNameId ではない場合。
• ipv4AclInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• ipv4AclInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な StandardAccessControlList または ExtendedAccessControlList InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapEntryInstanceNameId:VlanAccessMapEntry オブジェクトの InstanceNameId。
ipv4AclInstanceNameIdCol:1 つまたは複数の StandardAccessControlList または ExtendedAccessControlList オブジェクトの InstanceNameId のコレクション。
戻り値
void
unbindIpv6AclFromNetworkInterface
ネットワーク インターフェイスから IPv6 ACL アソシエーションを指定された方向にクリアします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• networkInterfaceInstanceNameId がヌルである、またはこれが有効な NetworkInterface オブジェクトの InstanceNameId ではない場合。
• direction がヌルの場合。
パラメータ
opContext:動作コンテキスト。
networkInterfaceInstanceNameId:削除する必要のある ACL が含まれている NetworkInterface オブジェクトの InstanceNameId。
direction:Ipv6AccessControlList オブジェクトを削除する必要のある方向。
戻り値
void
unbindIpv6AclsFromVlanAccessMapEntry
VACE から指定された IPv6 ACL のリストをクリアします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapInstanceNameId がヌル、または VlanAccessMapEntry InstanceNameId タイプではない場合。
• vlanAccessMapInstanceNameId が有効な VlanAccessMapEntry InstanceNameId ではない場合。
• ipv6AclInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• ipv6AclInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な Ipv6AccessControlList InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapEntryInstanceNameId:VlanAccessMapEntry オブジェクトの InstanceNameId。
ipv6AclInstanceNameIdCol:1 つまたは複数の Ipv6AccessControlList オブジェクトの InstanceNameId のコレクション。
戻り値
void
unbindMacAclFromNetworkInterface
ネットワーク インターフェイスから MAC ACL アソシエーションを指定された方向にクリアします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• networkInterfaceInstanceNameId がヌルである、またはこれが有効な NetworkInterface オブジェクトの InstanceNameId ではない場合。
• direction がヌルの場合。
パラメータ
opContext:動作コンテキスト。
networkInterfaceInstanceNameId:削除する必要のある ACL が含まれている NetworkInterface オブジェクトの InstanceNameId。
direction:MacAccessControlList オブジェクトを削除する必要のある方向。
戻り値
void
unbindMacAclsFromVlanAccessMapEntry
VACE から指定された MAC ACL のリストをクリアします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapInstanceNameId がヌル、または VlanAccessMapEntry InstanceNameId タイプではない場合。
• vlanAccessMapInstanceNameId が有効な VlanAccessMapEntry InstanceNameId ではない場合。
• macAclInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• macAclInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な MacAccessControlList InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapEntryInstanceNameId:VlanAccessMapEntry オブジェクトの InstanceNameId。
macAclInstanceNameIdCol:1 つまたは複数の MacAccessControlList オブジェクトの InstanceNameId のコレクション。
戻り値
void
unbindNetworkInterfacesFromVlanAccessMapEntry
リダイレクト インターフェイスとして割り当てられているネットワーク インターフェイスの指定されたリストを VACE からクリアします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• vlanAccessMapInstanceNameId がヌル、または VlanAccessMapEntry InstanceNameId タイプではない場合。
• vlanAccessMapInstanceNameId が有効な VlanAccessMapEntry InstanceNameId ではない場合。
• networkInterfaceInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• networkInterfaceInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な NetworkInterface InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
vlanAccessMapEntryInstanceNameId:VlanAccessMapEntry オブジェクトの InstanceNameId。
networkInterfaceInstanceNameIdCol:リダイレクトから削除する必要のある 1 つまたは複数の NetworkInterface オブジェクトの InstanceNameId のコレクション。
戻り値
void
unbindTimeRangeFromAces
1 つまたは複数の ACE から timerange をクリアします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• aceInstanceNameIdCol コレクションがヌル、またはこのコレクションが空である場合。
• aceInstanceNameIdCol コレクションにヌル要素が含まれる、またはこのコレクションに無効な ExtendedAccessControlEntry、Ipv6AccessControlEntry、または RoleBasedAccessControlEntry InstanceNameId が含まれている場合。
パラメータ
opContext:動作コンテキスト。
aceInstanceNameIdCol:1 つまたは複数の ACE の InstanceNameId のコレクション。ACE は、ExtendedAccessControlEntry、Ipv6AccessControlEntry、または RoleBasedAccessControlEntry です。
戻り値
void
unbindVlanAccessMapFromVlans
1 つまたは複数の VLAN から VACL をクリアします。
ValidationException は、次のいずれかの状況が発生した場合にスローされます。
• neInstanceNameId がヌル、または NetworkElement InstanceNameId タイプではない場合。
• neInstanceNameId が有効な NetworkElement InstanceNameId ではない場合。
• vlanIds 値がヌルの場合。
パラメータ
opContext:動作コンテキスト。
neInstanceNameId:NetworkElement の InstanceNameId。
vlanIds:VLAN を一意に識別するための 1 つまたは複数の VLAN ID。
戻り値
void