Versions Compared

Old Version 9

changes.mady.by.user Abhija Jayan

Saved on

compared with

New Version 10

changes.mady.by.user Abhija Jayan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagephp
themeConfluence
<EnvModelRuleBean>
 <id>12b620bd-2e74-4467-91e5-c29657022c05</id>
 <name>testName</name>
 <firmwareConfig>
  <id>f0b7b35b-4b8e-4a15-9d66-91c4b3d575d1</id>
  <description>prav_Firm</description>
  <supportedModelIds>
   <supportedModelIds>PX013ANM</supportedModelIds>
   <supportedModelIds>PX013ANC</supportedModelIds>
  </supportedModelIds>
  <firmwareFilename>PX013AN_2.1s11_VBN_HYBse-signed.bin</firmwareFilename>
  <firmwareVersion>PX013AN_2.1s11_VBN_HYBse-signed</firmwareVersion>
 </firmwareConfig>
 <environmentId>TEST</environmentId>
 <modelId>PX013ANC</modelId>
</EnvModelRuleBean>

Create/update an environment model rule

If EnvModelRule is missing it will be being created, otherwise updated. For update operation id field is not needed.

...

Code Block
languagephp
themeConfluence
<ArrayList>
 <item>
  <id>8bdb3493-a18b-4230-9b25-fd44df38863b</id>
  <name>name</name>
  <ipAddressGroup>
   <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</id>
   <name>test</name>
   <ipAddresses>
    <ipAddresses>192.11.11.11</ipAddresses>
   </ipAddresses>
  </ipAddressGroup>
  <warehouse>false</warehouse>
 </item>
 <item>
  <id>f9c5a6e8-d34f-4dc6-ae41-9016b70552ae</id>
  <name>namef</name>
  <ipAddressGroup>
   <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</id>
   <name>test</name>
   <ipAddresses>
    <ipAddresses>192.11.11.11</ipAddresses>
   </ipAddresses>
  </ipAddressGroup>
  <warehouse>false</warehouse>
 </item>
</ArrayList>

Retrieve an ip filter by name

GET http://<host>:<port>/queries/filters/ips/{ipFilterName}?applicationType={type}

...

Code Block
languagephp
themeConfluence
<IpFilter>
 <id>8bdb3493-a18b-4230-9b25-fd44df38863b</id>
 <name>name</name>
 <ipAddressGroup>
  <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</id>
  <name>test</name>
  <ipAddresses>
   <ipAddresses>192.11.11.11</ipAddresses>
  </ipAddresses>
 </ipAddressGroup>
 <warehouse>false</warehouse>
</IpFilter>

Create/update an IP filter

If IpFilter is missing it will be being created, otherwise updated. For update operation id field is not needed.

...

Request: http://<host>:<port>/delete/filters/ips/namef

Percent filter

Retrieve percent filter

GET http://<host>:<port>/queries/filters/percent?applicationType={type}

...

Code Block
languagephp
themeConfluence
<PercentFilterWrapper type="com.comcast.xconf.queries.beans.PercentFilterWrapper">
 <id>PERCENT_FILTER_VALUE</id>
 <percentage>99.0</percentage>
 <EnvModelPercentages>
  <percentage>100.0</percentage>
  <active>false</active>
  <firmwareCheckRequired>false</firmwareCheckRequired>
  <rebootImmediately>false</rebootImmediately>
  <lastKnownGood/>
  <intermediateVersion/>
  <firmwareVersions/>
  <name>123</name>
 </EnvModelPercentages>
 <EnvModelPercentages>
  <percentage>50.0</percentage>
  <active>true</active>
  <firmwareCheckRequired>true</firmwareCheckRequired>
  <rebootImmediately>true</rebootImmediately>
  <lastKnownGood>PR150BN_2.4p6s3_VBN_HYBsd</lastKnownGood>
  <intermediateVersion>PR150BN_2.3p7s1_PROD_HYBse</intermediateVersion>
  <firmwareVersions>
   <firmwareVersions>PR150BN_2.4p6s3_VBN_HYBsd</firmwareVersions>
   <firmwareVersions>PR150BN_2.4p8s3_VBN_HYBsd-signed</firmwareVersions>
   <firmwareVersions>PR150BN_2.3p7s1_PROD_HYBse</firmwareVersions>
  </firmwareVersions>
  <name>IV_6a</name>
 </EnvModelPercentages>
</PercentFilterWrapper>

Retrieve percent filter field values

GET http://<host>:<port>/queries/filters/percent?field=fieldName&applicationType={type}

...

Code Block
languagephp
themeConfluence
<ArrayList>
 <item>
  <id>4c2cea9e-c1be-4219-8f2a-70084f1cb648</id>
  <name>Percent Test 2</name>
  <active>false</active>
  <firmwareCheckRequired>false</firmwareCheckRequired>
  <rebootImmediately>false</rebootImmediately>
  <firmwareVersions/>
  <environment>envId</environment>
  <model>modelId</model>
  <distributions>
   <distributions>
    <configId>29ab0494-0ee9-406a-9189-a81598988a54</configId>
    <percentage>100.0</percentage>
   </distributions>
  </distributions>
 </item>
</ArrayList>

Retrive EnvModelPercentage by id

GET http://<host>:<port>/queries/percentageBean/id

...

Code Block
languagephp
themeConfluence
<PercentageBean>
 <id>4c2cea9e-c1be-4219-8f2a-70084f1cb648</id>
 <ttlMap/>
 <name>Percent Test 2</name>
 <active>false</active>
 <firmwareCheckRequired>false</firmwareCheckRequired>
 <rebootImmediately>false</rebootImmediately>
 <firmwareVersions/>
 <environment>envId</environment>
 <model>modelId</model>
 <distributions>
  <distributions>
   <configId>0c176c01-b4cf-4706-9e41-5118e30f68cb</configId>
   <percentage>100.0</percentage>
  </distributions>
 </distributions>
</PercentageBean>

Delete envModelPercentage

DELETE http://<host>:<port>/delete/percentageBean/id

...

Code Block
languagephp
themeConfluence
<TimeFilterWrapper>

    <id>cef2b340-2109-467e-a5d2-a70f0cddb432</id>

    <name>abc</name>

    <ipWhitelist>

        <id>0e277b6a-7d95-4421-b390-415b03de04b4</id>

        <name>60.70.80.90</name>

        <ipAddresses>

            <ipAddresses>60.70.80.90</ipAddresses>

        </ipAddresses>

    </ipWhitelist>

    <envModelWhitelist>

        <id>0f8110a3-4b60-489b-854e-c69e25b18abc</id>

        <environmentId>QA</environmentId>

        <modelId>SR150BNC</modelId>

    </envModelWhitelist>

    <neverBlockRebootDecoupled>true</neverBlockRebootDecoupled>

    <neverBlockHttpDownload>true</neverBlockHttpDownload>

    <startTime>01:00</startTime>

    <endTime>02:00</endTime>

    <localTime>true</localTime>

</TimeFilterWrapper>

Create/update time filter

If time filter is missing it will be being created, otherwise updated. For update operation id field is not needed.

...

Code Block
languagephp
themeConfluence
<TimeFilterWrapper>
    <id>cef2b340-2109-467e-a5d2-a70f0cddb432</id>
    <name>abc</name>
    <ipWhitelist>
        <id>0e277b6a-7d95-4421-b390-415b03de04b4</id>
        <name>60.70.80.90</name>
        <ipAddresses>
            <ipAddresses>60.70.80.90</ipAddresses>
        </ipAddresses>
    </ipWhitelist>
    <envModelWhitelist>
        <id>0f8110a3-4b60-489b-854e-c69e25b18abc</id>
        <environmentId>QA</environmentId>
        <modelId>SR150BNC</modelId>
    </envModelWhitelist>
    <neverBlockRebootDecoupled>true</neverBlockRebootDecoupled>
    <neverBlockHttpDownload>true</neverBlockHttpDownload>
    <startTime>01:00</startTime>
    <endTime>02:00</endTime>
    <localTime>true</localTime>
</TimeFilterWrapper>

Delete time filter by name

DELETE http://<host>:<port>/delete/filters/time/{timeFilterName}?applicationType={type}

...

Code Block
languagephp
themeConfluence
[{"id":"DEV","description":"ff"},{"id":"TEST","description":"do not delete"}]

Retrieve environment by id

GET http://<host>:<port>/queries/environments/<environmentId>

...

Code Block
languagephp
themeConfluence
<Environment>
 <id>DEV</id>
 <description>ff</description>
</Environment>

Create an environment

POST http://<host>:<port>/updates/environments

...

Code Block
languagephp
themeConfluence
{"id":"testName","description":"some description"}

Delete environment by id

DELETE http://<host>:<port>/delete/environments/<environmentId>

...

Code Block
languagephp
themeConfluence
<ArrayList>
 <item>
  <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</id>
  <name>test</name>
  <ipAddresses>
   <ipAddresses>192.11.11.11</ipAddresses>
  </ipAddresses>
 </item>
</ArrayList>

Retrieve an IP address group by IP

GET http://<host>:<port>/queries/ipAddressGroups/byIp/<ipAddressGroupIp>/

...

Code Block
languagephp
themeConfluence
<ArrayList>
 <item>
  <id>2c184325-f9eb-4edc-85c3-5b6466fc3c5c</id>
  <name>test</name>
  <ipAddresses>
   <ipAddresses>192.11.11.11</ipAddresses>
  </ipAddresses>
 </item>
</ArrayList>

Create an IP address group

POST http://<host>:<port>/updates/ipAddressGroups

...

Code Block
languagephp
themeConfluence
{"id":"2c184325-f9eb-4edc-85c3-5b6466fc3c5c","name":"test","ipAddresses":["192.11.11.11"]}

Add data to IP Address Group(dev in progress)

POST http://<host>:<port>/updates/ipAddressGroups/<ipAddressGroup_name>/addData

...

Code Block
languagephp
themeConfluence
<StringListWrapper>
 <list>
  <list>1.1.1.1</list>
 </list>
</StringListWrapper>

Delete an IP address group by id

DELETE http://<host>:<port>/delete/ipAddressGroups/<ipAddressGroupId>

...

Code Block
languagephp
themeConfluence
<ArrayList>
 <item>
  <name>test</name>
  <macListRef>macs</macListRef>
  <targetedModelIds>
   <targetedModelIds>YETST</targetedModelIds>
  </targetedModelIds>
  <firmwareConfig>
   <id>b65962b5-1481-4eed-a010-2abfa8c3bbfd</id>
   <description>_-</description>
   <supportedModelIds>
    <supportedModelIds>YETST</supportedModelIds>
   </supportedModelIds>
   <firmwareFilename>_-</firmwareFilename>
   <firmwareVersion>_-</firmwareVersion>
  </firmwareConfig>
 </item>
</ArrayList>

Retrieve a mac rule list (v2)

GET http://<host>:<port>/queries/rules/macs?version=2&applicationType={type}

...

Code Block
languagephp
themeConfluence
<ArrayList>
 <item>
  <id>18542fe1-94f2-487c-8f41-9f20965648f5</id>
  <name>test</name>
  <macListRef>macs</macListRef>
  <targetedModelIds>
   <targetedModelIds>YETST</targetedModelIds>
  </targetedModelIds>
  <firmwareConfig>
   <id>b65962b5-1481-4eed-a010-2abfa8c3bbfd</id>
   <description>_-</description>
   <supportedModelIds>
    <supportedModelIds>YETST</supportedModelIds>
   </supportedModelIds>
   <firmwareFilename>_-</firmwareFilename>
   <firmwareVersion>_-</firmwareVersion>
  </firmwareConfig>
  <macList>
   <macList>AA:AA:AA:AA:AA:AA</macList>
  </macList>
 </item>
</ArrayList>

Retrieve mac rule by name (legacy)

GET http://<host>:<port>/queries/rules/macs/{macRuleName}?applicationType={type}

...

Code Block
languagephp
themeConfluence
<MacRuleBeanWrapper>
 <id>18542fe1-94f2-487c-8f41-9f20965648f5</id>
 <name>test</name>
 <macListRef>macs</macListRef>
 <targetedModelIds>
  <targetedModelIds>YETST</targetedModelIds>
 </targetedModelIds>
 <firmwareConfig>
  <id>b65962b5-1481-4eed-a010-2abfa8c3bbfd</id>
  <description>_-</description>
  <supportedModelIds>
   <supportedModelIds>YETST</supportedModelIds>
  </supportedModelIds>
  <firmwareFilename>_-</firmwareFilename>
  <firmwareVersion>_-</firmwareVersion>
 </firmwareConfig>
 <macList>
  <macList>AA:AA:AA:AA:AA:AA</macList>
 </macList>
</MacRuleBeanWrapper>

Delete mac rule by name

DELETE http://<host>:<port>/delete/rules/macs/{macRuleName}?applicationType={type}

...

Code Block
languagephp
themeConfluence
<Model>
 <id>YETST</id>
 <description></description>
</Model>

Create model 

POST http://<host>:<port>/updates/models

...

Code Block
languagephp
themeConfluence
<ArrayList>
 <item>
  <id>macs</id>
  <data>
   <data>AA:AA:AA:AA:AA:AA</data>
  </data>
 </item>
</ArrayList>

Retrieve an NS list by id:

GET http://<host>:<port>/queries/nsLists/byId/<nsListId>

...

Code Block
languagephp
themeConfluence
<NamespacedList>
 <id>macs</id>
 <data>
  <data>AA:AA:AA:AA:AA:AA</data>
</data></NamespacedList>

Create a NS list

POST http://<host>:<port>/updates/nsLists

...

Code Block
languagephp
themeConfluence
<NamespacedList>
 <id>macs</id>
 <data>
  <data>AA:AA:AA:AA:AA:AA</data>
 </data>
</NamespacedList>

Add data to NS list

POST http://<host>:<port>/updates/nsLists/<nsListId>/addData

...

Code Block
languagephp
themeConfluence
<StringListWrapper>
 <list>
  <list>11:22:33:44:55:66</list>
 </list>
</StringListWrapper>

Delete data from NS list

DELETE http://<host>:<port>/updates/nsLists/<nsListId>/removeData

...

Code Block
languagephp
themeConfluence
<StringListWrapper>
 <list>
  <list>11:22:33:44:55:66</list>
 </list>
</StringListWrapper>

Delete an NS list by id

DELETE http://<host>:<port>/delete/nsLists/<nsListId>

...