Adaptor

The Adaptor object defines a slot in the MetaSwitch NE chassis where a communications card can be installed. There is an Adaptor object for each slot in the chassis. If an individual card is not installed in its slot, the corresponding Adaptor object still exists, but its parameters show that the card is not installed.

The entry for each adaptor in the EMS System Explorer's tree view shows the slot number and the type of adaptor card installed in the slot, or the configured card type if the installed card type cannot be determined. The adaptor card type is one of the following.

Adaptors used only with the VP3510 or MG3510:

Adaptors used with the VP3510 or MG3510:

Adaptors used with the VP3500, MG3500, VP3510 or MG3510:

In general, Adaptor objects and their child port objects will be included as part of the delivered configuration. You can add or delete Adaptor objects if you are adding new adaptor cards to the MetaSwitch chassis or changing the installed cards.

The EMS provides actions on the Adaptor object to create and manage the adaptor's child port objects, together with a number of fields on the Adaptor object that are used to specify default values for the child port objects. (These actions are not available if the Protection mode field is visible and set to Backup, because a backup adaptor does not have any child port objects.) This means that, when you add or change adaptor cards, you can easily make the corresponding changes to the Adaptor object's child port objects. Note that these child port actions may take some time to complete. You can check the progress of the most recent action using the field Port action status, and when the action has succeeded or failed you can use the field Port action log correlator to view the sequence of log messages relating to the action.

You need to enable and activate each individual adaptor (using the pushbuttons) before it can be used. (When you do this, the EMS raises an alarm if the appropriate adaptor card is not installed or not operating correctly.)

The adaptor objects also provide status information about each individual adaptor.

Each Adaptor object is a child of a Controller object.


The deactivation mode for an ATM Adaptor (Configured adaptor type set to PB1000 ATM Adaptor or PB2000 ATM Adaptor) is always Normal, and so there is no Deactivation mode option. If you deactivate an ATM Adaptor that is currently active in a Fault Tolerant ATM Port, active calls will be switched to the other adaptor; you can also force this change-over in the Fault Tolerant ATM Port object before deactivating the adaptor.



PB Adaptors with Physical DS1 Port objects or Physical DS3 Port objects will not quiesce deactivate under some circumstances. If the object is using a DS0 for MTP2 links, it will not deactivate until you deactivate the signaling cross connect .

Object-Specific Actions
Create all ports This action creates all of the child port objects below the adaptor.
Enable all ports This action enables all of the child port objects below the adaptor.
Activate all ports This action activates all of the child port objects below the adaptor.
Deactivate all ports This action deactivates all of the child port objects below the adaptor. Typically you will use this action to clean up the configuration before deleting an adaptor.
Disable all ports This action disables all of the child port objects below the adaptor. Typically you will use this action to clean up the configuration before deleting an adaptor.
Delete all ports This action deletes all of the child port objects below the adaptor. Typically you will use this action to clean up the configuration before deleting an adaptor.

Parameter

Access

Description
Slot number Read only The slot number to which this Adaptor object applies.
Configured adaptor type Change Inactive The type of adaptor card for which this slot is configured. Adaptors used only with the VP3510 or MG3510:
  • AM1300 Audio/MF Adaptor
Adaptors used with the VP3510 or MG3510:
  • SG1200 PSTN Signaling Adaptor (Stratum n), where n is either 3 or 3E
  • SG1200 PSTN Signaling Adaptor, if the clock stratum cannot be determined
Adaptors used with the VP3500, MG3500, VP3510 or MG3510:
  • AM1000 Audio/MF Adaptor
  • AM1100 Audio/MF Adaptor
  • AM1200 Audio/MF Adaptor
  • PB1000 ATM Adaptor
  • PB2000 ATM Adaptor
  • PB3000 Adaptor
  • PB4000 Adaptor
  • PB4500 Adaptor
  • PB5000 Adaptor
  • SA1000 DSP Resource Card
  • SG1000 PSTN Signaling Adaptor (Stratum 4)
  • SG1100 PSTN Signaling Adaptor (Stratum n), where n is either 3 or 3E
  • SG1100 PSTN Signaling Adaptor, if the clock stratum cannot be determined
  • TD1000 E1 TDM Adaptor
  • TD1100 E1 TDM Adaptor with DSP Mezzanine
Actual adaptor type Read only The type of adaptor card that is installed in the slot, if any. This information is displayed only if the parent Controller object is active. The values are the same as for Configured adaptor type. If the actual adaptor's family does not match the configured adaptor family, you will not be able to use the adaptor.
Actual rear transmission module type Read only This field appears only for a PB4000/4500/5000 adaptor card in a VP3510 or MG3510 chassis. The type of rear transmission module (RTM) that is installed in the slot, if any; different RTM types are used to provide protection switching for the adaptor cards. This information is displayed only if the parent Controller object is active. Values:
  • Unknown
    The RTM type cannot be determined.
  • RPS4000
    The RTM is an RPS4000; the adaptor card can operate as a primary adaptor protected by another adaptor.
  • RPS4010
    The RTM is an RPS4010; the adaptor card can operate as a backup adaptor protecting other adaptors.
  • RPB4000
    The RTM is an RPB4000; the adaptor card operates as a standalone adaptor.
Adaptor status Read only Physical status of the adaptor card. This information is displayed only if the parent Controller object is active. Values:
  • No adaptor in slot
    The card is not installed in the slot.
  • Available for use
    The card is installed and can be used.
  • Not available for use - safe to remove
    The card is not in use, and can be removed and replaced if necessary. (This corresponds to the blue Hot Swap indicator on the card being lit.)
  • Not available for use - not safe to remove
    The card is not in use, but may not work correctly if it is removed and replaced.
  • Not available for use - software initializing
    The card is not yet ready for use.
  • Adaptor failed and isolated - safe to remove
    The card is faulty, and can be removed and replaced if necessary.
  • Unknown
    The card status cannot be determined. This status typically indicates a hardware error on the adaptor. To clear this status, you can remove and replace the adaptor.
  • Unexpected status reported
    An error occurred during the attempt to determine the card status.
Deactivation mode Change Specifies how child objects should be deactivated when deactivating this object. This field is not displayed for a PB1000, PB2000, or PB3000 adaptor. Values:
  • Normal (default)
    Shut down child objects normally before deactivating the object.
  • Quiesce
    Deactivating the adaptor object in quiesce mode will wait for all existing child ports using the adaptor to be completed before deactivation. No new ports using this adaptor will be accepted during this deactivation period.
  • Abort
    Deactivate the object and all its child objects immediately. (This may result in errors at remote systems.)
Protection mode Change This field appears only for a TD* or PB4000 adaptor in a VP3500 or MG3500 that uses the EPS3500 protection switching mechanism, or for a PB4000/PB4500/PB5000 adaptor in a VP3510 or MG3510. Specifies the adaptor's role in protection switching. Values:
  • Primary
    The adaptor is a primary adaptor carrying TDM traffic, backed up by another adaptor.
  • Backup
    The adaptor is a backup adaptor to protect one or more primary adaptors. The EMS does not show any child port objects for this adaptor; port objects appear only as children of primary or standalone adaptors. You cannot change an Adaptor to Backup mode if an IAD is configured to use an ATM Port on the Adaptor.
  • Standalone
    The adaptor is carrying TDM traffic but is not backed up.
If this field is currently set to Primary, you can change it only when Desired operational adaptor is set to This adaptor. If this field is currently set to Backup, you can change it only when the adaptor is inactive (because changing from backup to primary or standalone requires changing the installed RTM hardware). If you attempt to Apply changes that are not compatible with the card's RTM and slot number, the EMS will prevent you from doing so. For example, if you try to set an Adaptor in slot 3 (the protecting slot) of a VP2510 or MG2510 to be a Primary adaptor, you will be prevented from doing so; the Adaptor in slot 3 must be the Backup adaptor or a Standalone adaptor, and cannot be a Primary (protected) adaptor. Similarly, if you set the same Adaptor to be a Backup adaptor when it does not have the RPS3110 RTM, the EMS will prevent you from applying the changes. The object will alarm if you activate it with this field set to a value that does not match the installed RTM hardware (if, for example, you change the RTMs you are using after having configured this object).
EPS number Change This field appears only for a VP3500 or MG3500 with Protection mode set to Primary. Specifies the port number (1 - 6) to which this adaptor is connected on the EPS3500 module at the rear of the chassis. For more information on connecting adaptors to this module, see the MetaSwitch VP3500 / MG3500 Network Element Installation and Maintenance Guide.
Desired operational adaptor Change This field appears only if Protection mode is visible and set to Primary. Specifies whether this adaptor or its backup should be operational. Values:
  • Switch automatically (default)
    Switch to the backup adaptor automatically if there is a problem with this adaptor.
  • This adaptor
    This adaptor should be operational.
  • Backup adaptor
    The backup adaptor should be operating instead of this adaptor.
Protection status Read only This field appears only if Protection mode is visible and set to Primary. Specifies whether this adaptor or its backup is currently operational. Values:
  • No valid backup configured
  • Backup available
  • Backup unavailable
  • Using backup
  • Switching
Protector status Read only This field appears only if Protection mode is visible and set to Backup. Specifies whether this adaptor is currently operating instead of a primary adaptor. Values:
  • No valid primary configured
  • Available
  • In use
  • Switching
Actual firmware version Read only The version level of the firmware currently running on this adaptor. If you have performed a software upgrade on the NE that included new firmware but have not yet restarted this adaptor to pick up the new firmware level, the level shown here may not be up to date.
  • For a VP3500 or MG3500, this field is displayed for information only. The value may be useful to MetaSwitch support personnel in diagnosing problems.
  • For a VP3510 or MG3510, this field is used in conjunction with the following field to determine whether the firmware level is up to date.
Desired firmware version Read only This field appears only for a VP3510 or MG3510. The latest version of the firmware currently available for this adaptor. This may be later than Actual firmware version, if you have performed a software upgrade on the NE that included new firmware but have not yet restarted this adaptor to pick up the new firmware level.
Reload firmware on deactivation or protection switch Change This field appears only for a VP3510 or MG3510. Specifies whether the adaptor should be upgraded to the new firmware level, if one is available, when it is next deactivated or when a protection switch next occurs. Values:
  • True
  • False (default)
Serial number Read only This field appears only for a PB4000, PB4500, PB5000, SG1100, SG1200 or AM1300 adaptor card. The hardware serial number of the adaptor card, which is a unique identifier for the physical hardware component.
RTM serial number Read only This field appears only for a PB4000, PB4500, or PB5000 adaptor card. The hardware serial number and revision number of the adaptor card's Rear Transmission Module. The serial number is a unique identifier for the physical hardware component.
Clock stratum Read only The clock stratum at which this adaptor is currently operating. This field appears only for an SG1100 or SG1200 adaptor. Values:
  • 3
  • 3E
  • 4
  • None
  • Unknown
    This status typically indicates a hardware error on the adaptor. To clear this status, you can remove and replace the adaptor.
Clock status Read only The status of the clocking on this adaptor. This field appears only for an SG1100 or SG1200 adaptor, but does not appear if Clock stratum is set to None. Values:
  • Locked onto reference 1
    The clocking is locked onto the first clock reference source.
  • Locked onto reference 2
    The clocking is locked onto the second clock reference source.
  • Holdover mode
    The adaptor cannot access either reference source, but is running on its internal clock which has previously been locked on to one of the reference sources.
  • Free running mode
    The adaptor has not yet been able to access a clock reference source, but is running on its internal clock.
  • Unknown
    The clock status cannot be determined. This typically indicates a hardware error on the adaptor. To clear this status, you can remove and replace the adaptor.
Clock end of range alarm status Read only Specifies whether the clock on this adaptor is reporting an End of Range (EOR) alarm. This field appears only for an SG1100 or SG1200 adaptor, and does not appear if Clock stratum is set to None. This alarm occurs when the clocking is locked on to a reference source, but at a frequency at the end of its accessible range; this may indicate a network problem or a hardware error on the adaptor. Values:
  • Clear
  • Alarmed
  • Unknown
    This status typically indicates a hardware error on the adaptor. To clear this status, you can remove and replace the adaptor.
Clock reference 1 - status Read only Indicates whether the first clock reference is available for use by the clock on this adaptor. This field appears only for an SG1100 or SG1200 adaptor, but does not appear if Clock stratum is set to None. Values:
  • Available
  • Alarmed
  • Unknown
    This status typically indicates a hardware error on the adaptor. To clear this status, you can remove and replace the adaptor.
Clock reference 2 - status Read only Indicates whether the second clock reference is available for use by the clock on this adaptor. This field appears only for an SG1100 or SG1200 adaptor, but does not appear if Clock stratum is set to None. Values:
  • Available
  • Alarmed
  • Unknown
    This status typically indicates a hardware error on the adaptor. To clear this status, you can remove and replace the adaptor.
Physical DS3 Port - Channelization Change This field appears only for a PB4000, PB4500 or PB5000 adaptor, and is used to provide defaults for DS3 ports created using the create all ports action. Indicates whether DS3 lines for ports below this adaptor are channelized into T1 or E1 channels. Values:
  • T1
  • E1
Physical DS3 Port - Default Line framing Change This field appears only for a PB4000, PB4500 or PB5000 adaptor, and is used to provide defaults for DS3 ports created using the create all ports action. Specifies the DS3 framing structure used on ports below this adaptor. This must match the framing on the incoming DS3 line. Values:
  • M23
  • C-bit parity
The default is M23, which is normally used in North America.
Physical DS3 Port - Default Line length Change This field appears only for a PB4000, PB4500 or PB5000 adaptor, and is used to provide defaults for DS3 ports created using the create all ports action. Specifies the approximate length of the DS3 cable connected to ports below this adaptor. This is used to control the DS3 transceivers to ensure adequate signal strength on the line. Values:
  • Less than 600ft (180m)
  • More than 600ft (180m)
DS1 Over DS3 Ports - Default Line framing Change This field appears only for a PB4000, PB4500 or PB5000 adaptor, and is used to provide defaults for DS1 Over DS3 ports created using the create all ports action. Specifies the framing used on DS1 ports below this adaptor. This setting must match the framing on the incoming DS1 line; check with the provider of the line if necessary. The following values are valid for DS1s on any adaptor card:
  • D4 (T1 only)
    AT&T D4 format DS1 (T1.107)
  • ESF (T1 only)
    Extended SuperFrame DS1 (T1.107)
  • E1 (E1 only)
    ITU-T Recommendation G.704 (Table 4a)
  • E1 CRC (E1 only)
    ITU-T Recommendation G.704 (Table 4b)
The following values are valid only for DS1s on a PB4000 , PB4500 or PB5000 adaptor:
  • D4 MF
    D4 with CAS support enabled
  • ESF MF
    ESF with CAS support enabled
DS1 Over DS3 Ports - Default Clock reference Change This field appears only for a PB4000, PB4500 or PB5000 adaptor, and is used to provide defaults for DS1 Over DS3 ports created using the create all ports action. Specifies whether the clocking on DS1 ports below this adaptor is used as a general clock reference. You should leave this value set to No. Values:
  • No (default)
    The DS1 link's clocking is not used as a general clock reference.
  • Yes
    The DS1 link's clocking is used as a general clock reference.
  • BITS
    Building Integrated Timing Supply: this DS1 link is used only as a general clock reference, and does not carry data. In the supplied configuration files, port 8 on an SG1100 or SG1200 adaptor is normally configured for use with a BITS source.
Physical DS1 Port - Default Physical encoding Change This field appears only for a TD*, AM*, SG*, or PB3000 adaptor, and is used to provide defaults for Physical DS1 ports created using the create all ports action. This field is not used for an AM* adaptor, which does not support Physical DS1 Ports. Specifies the physical encoding used on DS1 ports below this adaptor. This setting must match the encoding of the incoming DS1 line; check with the provider of the line if necessary. Values:
  • B8ZS (T1 only)
  • AMI
  • HDB3 (E1 only)
Physical DS1 Port - Default Line framing Change This field appears only for a TD*, AM*, SG*, PB3000 adaptor, and is used to provide defaults for Physical DS1 ports created using the create all ports action. This field is not used for an AM* adaptor, which does not support Physical DS1 Ports. Specifies the framing used on DS1 ports below this adaptor. This setting must match the framing on the incoming DS1 line; check with the provider of the line if necessary. The following values are valid for DS1s on any adaptor card:
  • D4 (T1 only)
    AT&T D4 format DS1 (T1.107)
  • ESF (T1 only)
    Extended SuperFrame DS1 (T1.107)
  • E1 (E1 only)
    ITU-T Recommendation G.704 (Table 4a)
  • E1 CRC (E1 only)
    ITU-T Recommendation G.704 (Table 4b)
The following values are valid only for an AM* or PB3000 adaptor:
  • D4 MF
    D4 with CAS support enabled
  • ESF MF
    ESF with CAS support enabled
Physical DS1 Port - Default Line length Change This field appears only for a TD*, AM*, SG*, or PB3000 adaptor, and is used to provide defaults for Physical DS1 ports created using the create all ports action. This field is not used for an AM* adaptor, which does not support Physical DS1 Ports. Specifies the approximate length of the DS1 cable connected to DS1 ports below this adaptor. This is used to control the transceivers to ensure adequate signal strength on the line. This field is not valid if Line framing is set to E1 or E1 CRC. Values:
  • Up to 133ft (40m)
  • 133 - 266ft (40 - 80m)
  • 266 - 399ft (80-120m)
  • 399 - 533ft (120-160m)
  • Over 533ft (160m)
Physical DS1 Port - Default E1 line impedance Change This field appears only for a TD*, AM*, SG*, or PB3000 adaptor, and is used to provide defaults for Physical DS1 ports created using the create all ports action. This field is not used for an AM* adaptor, which does not support Physical DS1 Ports. Indicates the impedance of the E1 line. This field is valid only if Line framing is set to E1 or E1 CRC. Values:
  • 120 Ohms (default)
  • 75 Ohms
Physical DS1 Port - Default Clock reference Change This field appears only for a TD*, AM*, SG*, or PB3000 adaptor, and is used to provide defaults for Physical DS1 ports created using the create all ports action. This field is not used for an AM* adaptor, which does not support Physical DS1 Ports. Specifies whether the clocking on DS1 ports below this adaptor is used as a general clock reference, or is used just for the port itself. Values:
  • No (default)
    The DS1 link's clocking is not used as a general clock reference.
  • Yes
    The DS1 link's clocking is used as a general clock reference.
  • BITS
    Building Integrated Timing Supply: this DS1 link is used only as a general clock reference, and does not carry data. In the supplied configuration files, port 8 on an SG1100 or SG1200 adaptor is normally configured for use with a BITS source.
Physical DS1 Port - MF Protocol Profile Change This field is not used in the UK.
IP Media Port - IP address Change This field appears only for a PB* adaptor in a VP3510, and is used to provide defaults for IP Media ports created using the create all ports action. The IP address used for VoIP communications on this port.
Port deactivation mode Change Specifies how child port objects should be deactivated when using the action to deactivate all ports. You cannot change this field while an action on the adaptor's child ports is in progress. Values:
  • Normal (default)
    Shut down child objects normally before deactivating the object.
  • Quiesce
    Deactivating the object in quiesce mode will wait for all existing child objects using the object to be completed before deactivation. No new child objects will be accepted during this deactivation period.
  • Abort
    Deactivate the object and all its child objects immediately. (This may result in errors at remote systems.)
Port action status Read only The status of the most recent action taken on child port objects for this adaptor. Values:
  • None
  • Creating ports
  • Enabling ports
  • Activating ports
  • Deactivating ports
  • Disabling ports
  • Deleting ports
  • Created ports
  • Enabled ports
  • Activated ports
  • Deactivated ports
  • Disabled ports
  • Deleted ports
  • Failed to create ports
  • Failed to enable ports
  • Failed to activate ports
  • Failed to deactivate ports
  • Failed to disable ports
  • Failed to delete ports
Port action log correlator Read only When an action on child port objects for this adaptor has succeeded or failed, this field contains a correlator for the log message that contains a summary of the action and its progress. Click on the 'go to log' button next to this field to jump to this message in the EMS log viewer window. If there are earlier logs relating to the action (for example if one or more individual ports could not be created or activated), you can follow the links within the log viewer to see these logs.
Port action log correlator MetaSwitch Read only When an action on child port objects for this adaptor has succeeded or failed, this field contains the name of the EMS Server or MetaSwitch Network Element that generated the failure log. You may need this information to find the log in the EMS log viewer window.
Alarm state Read only Specifies whether any alarms are currently raised for this object. Values:
  • Clear
    No alarms are currently raised.
  • Attention Required
    Attention Required - the object is not operating normally, and needs operator intervention.
  • Attend To Dependent
    Attention Required elsewhere - another object on which this object depends is not operating normally.
Alarm state changed timestamp Read only The time at which the Alarm state last changed.
Alarm log correlator - Attention Required Read only Identifier of the log message for the event that caused the last Attention Required alarm state for this object. This field is reset when the Attention Required alarm events field is reset to zero.
Attention Required alarm events reset timestamp Read only The time at which the Attention Required alarm events was last reset to zero.
Alarm log correlator - Attend To Dependent Read only Identifier of the log message for the event that caused the last Attend To Dependent alarm state for this object. This field is reset when the Attend To Dependent alarm events field is reset to zero.
Attend To Dependent alarm events Read only / Reset The total number of times that the alarm state for this Adaptor has gone to Attend To Dependent.
Attend To Dependent alarm events reset timestamp Read only The time at which the Attend To Dependent alarm events was last reset to zero.
Port Attention Required alarms Read only The total number of Ports (and their child objects) associated with this Adaptor that are in Attention Required state.
Port Attention Required alarm events Read only / Reset The total number of times that the alarm state for a Port child object of this Adaptor (or one of its child objects) has gone to Attention Required.
Summary child alarm state Read only Summarizes the alarm status for all children of this object. Values:
  • Clear
    No alarms are currently raised.
  • Attention Required
    Attention Required - one or more child objects are not operating normally, and need operator intervention.
  • Attend To Dependent
    Attention Required elsewhere - another object on which one or more child objects depend is not operating normally.
Requested status Read only Specifies whether an administrator has attempted to activate the adaptor. Values:
  • Active
    The object has been activated.
  • Inactive
    The object has not been activated or has been deactivated.
  • Disabled
    The object has been disabled.
Actual status Read only Specifies the current status of the adaptor. Values:
  • Active
    The object is active.
  • Activating
    Activation is in progress.
  • Deactivating
    Deactivation is in progress.
  • Inactive
    The object is inactive.
  • Disabled
    The object has been disabled.
  • Activation Failed
    The object is inactive because an activation attempt has failed.
  • Failed
    The object was active but has failed.
  • Quiescing
    The object is preparing for normal deactivation. It is operating normally but will not accept any new users.
  • Waiting For Parent
    The object cannot be used because its parent object is not yet active.
  • Parent Failed
    The object cannot be used because its parent object has failed.