protocol/cfm

Resource URIs


URI	Description
<base_URI>/config/running/protocol/cfm	Configures CFM protocol.


GET URIs	Description
<base_URI>/config/running/protocol/cfm	Retrieves CFM protocol configuration.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}	Retrieves maintenance domain details.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}	Retrieves maintenance association.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/ccm-interval	Retrieves CCM interval details.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mip-policy	Retrieves MIP policy details.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}	Retrieves maintenance endpoint details.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}/tlv-type	Retrieves TLV details.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}/remote-mep/{remote-map}	Retrieves remote maintenance endpoint details.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/maid-format	Retrieves format for the maintenance association name. Allowed values: long, short.


POST URIs	Payload	Description
<base_URI>/config/running/protocol	<cfm />	Configures CFM protocol.
<base_URI>/config/running/protocol/cfm	<domain-name><domain-name>{string}</domain-name><level>{unit32}</level></domain-name>	Configures maintenance domain.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}	<ma-name><ma-name>{string}</ma-name><id>{unit32}</id><vlan>{unit32}</vlan><priority>{unit32}</priority></ma-name>	Configures maintenance association VLAN identifier.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}	<ma-name><ma-name>{string}</ma-name><id>{uint32}</id><bridge-domain>{uint32}</bridge-domain><priority>{uint32}</priority></ma-name>	Configures a unique L2VPN domain of the maintenance association.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}	<mep><mep-id>{unit32}</mep-id><mep-down-up>{string}</mep-down-up><vlan>{unit32}</vlan><inner-vlan>{uint32}</inner-vlan><mep-intf-type>{interface-type}</mep-intf-type><mep-intf-name>{interface-name}</mep-intf-name></mep>	Configures Maintenance End Point (MEP).
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}	<remote-mep><remote-mep>{unit32}</remote-mep></remote-mep>	Configures the remote Maintenance End Point (MEP).


PATCH URIs	Payload	Description
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}	<domain-name><level>{unit32}</level></domain-name>	Configures maintenance domain.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}	<ma-name><id>{unit32}</id><vlan>{unit32}</vlan><priority>{unit32}</priority></ma-name>	Configures maintenance association VLAN.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}	<ma-name><id>{uint32}</id><bridge-domain>{uint32}</bridge-domain><priority>{uint32}</priority></ma-name>	Configures maintenance association L2VPN domain.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}	<ma-name><ccm-interval>{enumeration}</ccm-interval></ma-name>	Configures maintenance association CCM interval.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}	<ma-name><mip-policy>{enumeration}</mip-policy></ma-name>	Configures Maintenance Intermediate Point (MIP).
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}	<mep><mep-down-up>{enumeration}</mep-down-up><vlan>{unit32}</vlan><inner-vlan>{uint32}</inner-vlan><mep-intf-type>{interface-type}</mep-intf-type><mep-intf-name>{interface-name}</mep-intf-name></mep>	Configures Maintenance End Point (MEP).
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}	<mep><tlv-type>{enumeration}</tlv-type></mep>	Configures Type, Length, Values (TLV) value.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}	<ma-name><maid-format>{maid-format-type}</maid-format></ma-name>	Configures format for the maintenance association ID. Allowed values: long, short.


PUT URIs	Payload	Description
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/ccm-interval	<ccm-interval>{enumeration}</ccm-interval>	Configures the time interval between two successive Continuity Check Messages (CCMs) that are sent by MEPs in the specified Maintenance Association (MA)
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mip-policy	<mip-policy>{enumeration}</mip-policy>	Configures Maintenance Intermediate Point (MIP) policy.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}/tlv-type	<tlv-type>{enumeration}</tlv-type>	Configures Type, Length, Values (TLV) value.
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/maid-format	<maid-format>{maid-format-type}</maid-format>	Configures format for the maintenance association ID. Allowed values: long, short.


DELETE URIs
<base_URI>/config/running/protocol/cfm
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mip-policy
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/mep/{mep-id}/remote-mep/{remote-mep-id}
<base_URI>/config/running/protocol/cfm/domain-name/{domain-name}/ma-name/{ma-name}/maid-format

Parameters

domain-name

Specifies the maintenance domain name.

ma-name

Specifies the maintenance association name.

id

Specifies the MA ID used for short-MAID.

maid-format

The format for MAID. Allowed values:

short: MAID does not include MD maintenance domain name and has only short MA name (default).
long: MAID includes MD name.

level

Specifies the maintenance domain level.

bridge-domain

Specifies the bridge domain.

priority

Specifies the priority for MA.

mep-id

Specifies maintenance endpoint ID.

mep-down-up

Specifies whether endpoint is up or down.

remote-mep

Specifies remote enpoint.

ccm-interval

Specifies the CCM interval. The default value is 10-seconds.

mip-policy

Specifies the MIP policy.

tlv-type

Specifies the TLV type.

inner-vlan

Specifies the inner-vlan ID for the MEP. Range: 1 to 4095.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/protocol/cfm

None

<cfm xmlns="urn:brocade.com:mgmt:brocade-dot1ag" xmlns:y="http://brocade.com/ns/rest" y:self="/rest/config/running/protocol/cfm">
  <domain-name y:self="/rest/config/running/protocol/cfm/domain-name/test">
    <domain-name>test</domain-name>
    <level>1</level>
    <ma-name y:self="/rest/config/running/protocol/cfm/domain-name/test/ma-name/name">
      <ma-name>name</ma-name>
      <id>1</id>
      <vlan>120</vlan>
      <priority>1</priority>
      <ccm-interval>1-second</ccm-interval>
      <mep y:self="/rest/config/running/protocol/cfm/domain-name/test/ma-name/name/mep/1">
        <mep-id>1</mep-id>
        <mep-down-up>up</mep-down-up>
        <mep-intf-type>ethernet</mep-intf-type>
        <mep-intf-name>1/15</mep-intf-name>
      </mep>
    </ma-name>
  </domain-name>
</cfm>

URI

The following example uses the POST option to configure CFM domain.

http://host:80/rest/config/running/protocol/cfm

<domain-name>
  <domain-name>test</domain-name>
  <level>5</level>
</domain-name>

None

URI

The following example uses the DELETE option to remove CFM configuration.

http://host:80/rest/config/running/protocol/cfm

None