SAPC Massive Operations over CLI
Ericsson Dynamic Activation 1

Contents

1Introduction
1.1Purpose and Scope
1.2Target Group
1.3Typographic Conventions

2

SAPC Conditional Search Command
2.1Print Families and Corresponding Subscribers (PCMSFMP)
2.1.1PCMSFMP Request
2.1.2PCMSFMP Result File Schema

3

Faults or Errors
3.1General CLI Errors
3.2Command Mapped Errors

Reference List

1   Introduction

This document covers the massive operations available through the Ericsson™ Dynamic Activation (EDA) Command Line Interface (CLI) for Service-Aware Policy Controller (SAPC) data.

Note:  
This function is only supported for layered SAPC.

1.1   Purpose and Scope

This document describes SAPC conditional search commands.

How to use these commands is covered in the document Generic CLI Interface Specification, Reference [1].

1.2   Target Group

The target group for this document is as follows:

For more information regarding the different target groups, see Library Overview, Reference [2].

1.3   Typographic Conventions

Typographic conventions are described in the document Library Overview, Reference [2].

For information about abbreviations used throughout this document refer to Glossary of Terms and Acronyms, Reference [3].

2   SAPC Conditional Search Command

This section covers all SAPC conditional search commands through the Dynamic Activation CLI. All conditional search commands generate response files, rather than printing the answer directly to the client.

The following SAPC search command is available:

2.1   Print Families and Corresponding Subscribers (PCMSFMP)

The PCMSFMP command supports massive print of the SAPC subscriptions and the SAPC families.

2.1.1   PCMSFMP Request

Command syntax:

PCMSFMP[:FAMILYID=familyid];

Examples of the PCMSFMP command

PCMSFMP;

This CLI command prints the identifiers of all families and the identifiers of their respective subscribers.

PCMSFMP:FAMILYID=family1234;

This CLI command prints the identifiers of all subscribers that belong to the family with identifier family1234.

The following table covers the attribute that can be used in a PCMSFMP request.

Table 1    Command Attribute

Attribute

Type

Occurrence

Description

FAMILYID

String


Min Length = 1


Max. Length = 32

Optional

The identifier of the family

2.1.2   PCMSFMP Result File Schema

Example 1 is an example of the result file schema for PCMSFMP:

Example 1   PCMSFMP Result File Schema

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
   targetNamespace="http://schemas.ericsson.com/ma/SAPC/" elementFormDefault="qualified"
   attributeFormDefault="qualified">
  <xs:element name="SAPCFamilyMemberData">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="SAPCFamily" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="pcFamilyId" type="xs:string" />
              <xs:element name="pcSubscriberId" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

The following table covers the attributes that can be received in a PCMSFMP response.

Table 2    Result Attributes

Attribute

Type

Occurrence

Description

pcFamilyId

String


Min Length = 1


Max. Length = 32

Mandatory

The identifier of the family to which the subscribers belong

pcSubscriberId

String


Min Length = 1


Max. Length = 32

Optional


(0-n)

The identifier of the subscriber

3   Faults or Errors

The CLI error codes can appear both directly in the prompt, and in the result files. Besides the generic and common error codes, the CLI commands can also return some more specific error codes.

3.1   General CLI Errors

The following table covers Dynamic Activation internal error codes. They can appear in any CLI responses.

Table 3    General Dynamic Activation Internal Error Codes

Error Code

Error Message

1001

Invalid resource.

1002

Invalid XPath.

1003

Unrecognized namespace. No data view associated.

1004

Access denied. Invalid principal or credentials.

1005

Not authorized to perform current operation on selected data view.

1006

Invalid parameter.

1007

The XPath failed to match any data in the processed XML.

1008

Failed to provision data.

1009

Unsupported operation.

1093

Could not process request because of limit of maximum number of concurrent ongoing CLI transactions reached.

1095

Communication error while interacting with a Network Element.

1096

Time-out expired during wait for answer from Network Element.

1097

Failure during processing of the request.

1098

Could not process request because of resource limitation.

1099

System error.

1100

Execution was canceled.

1101

External error.

1103

License error.

3.2   Command Mapped Errors

This section covers SAPC provisioning interface errors that are mapped towards certain commands. The commands listed in this section can be assumed to be stopping, unless "(not stopping)" is stated. They are listed in the following table along with the commands that can return them.

Table 4    Command Mapped Errors

Error Code

Error Message

Command

17007

FAMILY NOT DEFINED

PCMSFMP


Reference List

Ericsson Documents
[1] Generic CLI Interface Specification, 15/155 19-CSH 109 628 Uen
[2] Library Overview, 18/1553-CSH 109 628 Uen
[3] Glossary of Terms and Acronyms, 0033-CSH 109 628 Uen


Copyright

© Ericsson AB 2017. All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to continued progress in methodology, design, and manufacturing.

Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

Trademark List
All trademarks mentioned herein are the property of their respective owners. These are shown in the document Trademark Information.

    SAPC Massive Operations over CLI         Ericsson Dynamic Activation 1