{"type":"doc","content":[{"type":"paragraph","content":[{"text":"DESCRIPTION","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#0000ff"}}]}]},{"type":"paragraph","content":[{"text":"The Policy subsystem of ONAP maintains, distributes, and operates on the set of rules that underlie ONAP’s control, orchestration, and management functions. Policy provides a centralized environment for the creation and management of easily-updatable conditional rules. It enables users to validate policies and rules, identify and resolve overlaps and conflicts, and derive additional policies where needed. The following operations are supported by the policy API:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create policies on the PAP","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update policies on the PAP","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Delete policies on the PAP or PDP","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Push policies from the PAP to the PDP","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"List policies on the PDP","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Get config data of policies on the PDP","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create Dictionary Items","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update Dictionary Items","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Retrieve Dictionary Items","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Import Micro Services Models","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Retrieve Metrics for policy counts from PDP and PAP","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"POLICY ENGINE SERVICES","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#0000ff"}}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":1615,"id":"746b2934-7ede-4dc0-a3b0-069b32455319","collection":"contentId-16220240","type":"file","height":930}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"SAMPLE JAVA CLIENT CODE","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#0000ff"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get Config Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/*-\n * ============LICENSE_START=======================================================\n * PolicyEngineClient\n * ================================================================================\n * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\n * ================================================================================\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * \n * http://www.apache.org/licenses/LICENSE-2.0\n * \n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n * ============LICENSE_END=========================================================\n */\n \npackage org.onap.policyEngine;\n \nimport java.util.Collection;\n \nimport org.onap.policy.api.ConfigRequestParameters;\nimport org.onap.policy.api.PolicyConfig;\nimport org.onap.policy.api.PolicyEngine;\n \npublic class GetConfigSample {\n \n public static void main(String[] args) throws Exception {\n PolicyEngine pe = new PolicyEngine(\"config.properties\");\n ConfigRequestParameters configRequestParams = new ConfigRequestParameters();\n configRequestParams.setPolicyName(\".*\");\n Collection configs = pe.getConfig(configRequestParams);\n for (PolicyConfig config: configs){\n System.out.println(config.getPolicyConfigMessage());\n System.out.println(config.getPolicyConfigStatus());\n }\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create Config FIrewall Policy Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/*-\n * ============LICENSE_START=======================================================\n * PolicyEngineClient\n * ================================================================================\n * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\n * ================================================================================\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * \n * http://www.apache.org/licenses/LICENSE-2.0\n * \n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n * ============LICENSE_END=========================================================\n */\n \npackage org.onap.policyEngine;\n \nimport java.io.File;\nimport java.io.FileInputStream;\nimport java.io.FileNotFoundException;\nimport java.io.IOException;\nimport java.io.InputStream;\nimport java.io.StringReader;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\nimport java.text.SimpleDateFormat;\nimport java.util.Date;\nimport java.util.UUID;\n \nimport javax.json.Json;\nimport javax.json.JsonObject;\nimport javax.json.JsonReader;\n \nimport org.onap.policy.api.PolicyChangeResponse;\nimport org.onap.policy.api.PolicyConfigType;\nimport org.onap.policy.api.PolicyEngine;\nimport org.onap.policy.api.PolicyParameters;\nimport org.onap.policy.api.PolicyType;\n \npublic class ConfigFirewallPolicyClient {\n static Boolean isEdit = false;\n public static void main(String[] args) {\n try{ \n PolicyEngine policyEngine = new PolicyEngine(\"config.properties\");\n PolicyParameters policyParameters = new PolicyParameters();\n // Set Policy Type\n policyParameters.setPolicyConfigType(PolicyConfigType.Firewall); //required\n policyParameters.setPolicyName(\"MikeAPItesting.testConfigFirewallPolicy1607_1\"); //required\n //policyParameters.setPolicyScope(\"MikeAPItesting\");\n //Directory will be created where the Policies are saved... this \ndisplays a a subscope on the GUI\n policyParameters.setRequestID(UUID.randomUUID());\n \n // Set Safe Policy value for Risk Type\n SimpleDateFormat dateformat3 = new SimpleDateFormat(\"dd/MM/yyyy\");\n Date date = dateformat3.parse(\"15/10/2016\");\n policyParameters.setTtlDate(date);\n // Set Safe Policy value for Guard\n policyParameters.setGuard(true);\n // Set Safe Policy value for Risk Level\n policyParameters.setRiskLevel(\"5\");\n // Set Safe Policy value for Risk Type\n policyParameters.setRiskType(\"PROD\");\n File jsonFile = null;\n String jsonRuleList = null;\n Path file = Paths.get(\"C:\\\\policyAPI\\\\firewallRulesJSON\\\\Config_FW_Sample.json\");\n jsonFile = file.toFile();\n \n //buildJSON(jsonFile, jsonRuleList);\n policyParameters.setConfigBody(buildJSON(jsonFile, jsonRuleList).toString()); \n policyParameters.setConfigBodyType(PolicyType.JSON);\n // API method to create Policy or update policy\n PolicyChangeResponse response = null;\n if (!isEdit) {\n response = policyEngine.createPolicy(policyParameters);\n } else {\n response = policyEngine.updatePolicy(policyParameters);\n }\n \n if(response.getResponseCode()==200){\n System.out.println(response.getResponseMessage());\n System.out.println(\"Policy Created Successfully!\");\n }else{\n System.out.println(\"Error! \" + response.getResponseMessage());\n }\n } catch (Exception e) {\n System.err.println(e.getMessage());\n }\n \n}\n \n private static JsonObject buildJSON(File jsonInput, String jsonString) throws FileNotFoundException {\n JsonObject json = null;\n JsonReader jsonReader = null;\n if (jsonString != null && jsonInput == null) {\n StringReader in = null;\n in = new StringReader(jsonString);\n jsonReader = Json.createReader(in);\n json = jsonReader.readObject();\n in.close();\n } else {\n InputStream in = null;\n in = new FileInputStream(jsonInput); \n jsonReader = Json.createReader(in);\n json = jsonReader.readObject();\n try {\n in.close();\n } catch (IOException e) {\n System.err.println(\"Exception Occured while closing input stream\"+e);\n }\n }\n jsonReader.close();\n return json;\n }\n \n}","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Sample JSON file - Config_FW_Sample.json","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"{\n \"serviceTypeId\": \"/v0/firewall/pan\",\n \"configName\": \"AFTTFwPolicy1Config\",\n \"deploymentOption\": {\n \"deployNow\": false\n },\n \"securityZoneId\": \"cloudsite:dev1a\",\n \"serviceGroups\": [{\n \"name\": \"SSH\",\n \"description\": \"Ssh service entry in service list\",\n \"type\": \"SERVICE\",\n \"transportProtocol\": \"tcp\",\n \"appProtocol\": null,\n \"ports\": \"22\"\n }],\n \"addressGroups\": [{\n \"name\": \"CiscoVCE\",\n \"description\": \"Destination CiscoCVE\",\n \"members\": [{\n \"type\": \"SUBNET\",\n \"value\": \"12.63.31.61/12\"\n }]\n }, {\n \"name\": \"HOHOServers\",\n \"description\": \"Source HOHOServers for first testing\",\n \"members\": [{\n \"type\": \"SUBNET\",\n \"value\": \"12.60.32.11/23\"\n }]\n }],\n \"firewallRuleList\": [{\n \"position\": \"1\",\n \"ruleName\": \"FWRuleHOHOServerToCiscoVCE\",\n \"fromZones\": [\"UntrustedZoneCiscoCVEName\"],\n \"toZones\": [\"TrustedZoneHOHOName\"],\n \"negateSource\": false,\n \"negateDestination\": false,\n \"sourceList\": [{\n \"type\": \"REFERENCE\",\n \"name\": \"HOHOServers\"\n }],\n \"destinationList\": [{\n \"type\": \"REFERENCE\",\n \"name\": \"CiscoVCE\"\n }],\n \"sourceServices\": [],\n \"destServices\": [{\n \"type\": \"REFERENCE\",\n \"name\": \"SSH\"\n }],\n \"action\": \"accept\",\n \"description\": \"FW rule for HOHO source to CiscoVCE destination\",\n \"enabled\": true,\n \"log\": true\n }]\n}","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete Policy Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/*-\n * ============LICENSE_START=======================================================\n * PolicyEngineClient\n * ================================================================================\n * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\n * ================================================================================\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * \n * http://www.apache.org/licenses/LICENSE-2.0\n * \n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n * ============LICENSE_END=========================================================\n */\n \npackage org.onap.policyEngine;\n \nimport org.onap.policy.api.DeletePolicyCondition;\nimport org.onap.policy.api.DeletePolicyParameters;\nimport org.onap.policy.api.PolicyChangeResponse;\nimport org.onap.policy.api.PolicyEngine;\n \npublic class DeletePolicyClient {\n \n public static void main(String[] args) {\n try {\n \n PolicyEngine policyEngine = new PolicyEngine(\"config.properties\");\n DeletePolicyParameters policyParameters = new DeletePolicyParameters(); \n \n //Parameter arguments\n policyParameters.setPolicyName(\"MikeConsole.Config_testDeleteAPI6.1.xml\");\n policyParameters.setPolicyComponent(\"PDP\");\n policyParameters.setPdpGroup(\"default\");\n policyParameters.setDeleteCondition(DeletePolicyCondition.ALL);\n policyParameters.setRequestID(null);\n \n // API method to Push Policy to PDP\n PolicyChangeResponse response = null;\n response = policyEngine.deletePolicy(policyParameters);\n \n if(response.getResponseCode()==200){\n System.out.println(response.getResponseMessage());\n System.out.println(\"Policy Deleted Successfully!\");\n }else{\n System.out.println(\"Error! \" + response.getResponseMessage());\n }\n \n } catch (Exception e) {\n System.err.println(e.getMessage()); \n \n }\n \n }\n \n \n}","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Push Policy Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/*-\n * ============LICENSE_START=======================================================\n * PolicyEngineClient\n * ================================================================================\n * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\n * ================================================================================\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * \n * http://www.apache.org/licenses/LICENSE-2.0\n * \n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n * ============LICENSE_END=========================================================\n */\n \npackage org.onap.policyEngine;\n \nimport org.onap.policy.api.PolicyChangeResponse;\nimport org.onap.policy.api.PolicyEngine;\nimport org.onap.policy.api.PushPolicyParameters;\n \npublic class PushPoliciesToPDP {\n public static void main(String[] args) {\n try {\n \n PolicyEngine policyEngine = new PolicyEngine(\"config.properties\");\n PushPolicyParameters policyParameters = new PushPolicyParameters(); \n \n //Parameter arguments\n policyParameters.setPolicyName(\"Mike.testCase1\");\n policyParameters.setPolicyType(\"Base\");\n //policyParameters.setPolicyScope(\"MikeAPItesting\");\n policyParameters.setPdpGroup(\"default\"); \n policyParameters.setRequestID(null);\n \n // API method to Push Policy to PDP\n PolicyChangeResponse response = null;\n response = policyEngine.pushPolicy(policyParameters);\n \n if(response.getResponseCode()==204){\n System.out.println(response.getResponseMessage());\n System.out.println(\"Policy Pushed Successfully!\");\n }else{\n System.out.println(\"Error! \" + response.getResponseMessage());\n }\n \n } catch (Exception e) {\n System.err.println(e.getMessage()); \n \n }\n \n }\n \n}","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Decision Policy Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/*-\n * ============LICENSE_START=======================================================\n * PolicyEngineClient\n * ================================================================================\n * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\n * ================================================================================\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * \n * http://www.apache.org/licenses/LICENSE-2.0\n * \n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n * ============LICENSE_END=========================================================\n */\n \npackage org.onap.policyEngine;\n \nimport java.util.Arrays;\nimport java.util.HashMap;\nimport java.util.LinkedList;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.UUID;\n \nimport org.onap.policy.api.AttributeType;\nimport org.onap.policy.api.PolicyChangeResponse;\nimport org.onap.policy.api.PolicyClass;\nimport org.onap.policy.api.PolicyEngine;\nimport org.onap.policy.api.PolicyParameters;\n \npublic class DecisionPolicyClient {\n static Boolean isEdit = true;\n public static void main(String[] args) {\n try {\n PolicyEngine policyEngine = new PolicyEngine(\"config.properties\");\n PolicyParameters policyParameters = new PolicyParameters();\n // Set Policy Type\n policyParameters.setPolicyClass(PolicyClass.Decision); //required\n policyParameters.setPolicyName(\"MikeAPItests.testDecisionAPI\"); //required\n policyParameters.setOnapName(\"java\"); //required\n policyParameters.setPolicyDescription(\"This is a sample Decision policy UPDATE example with Settings\"); //optional\n //policyParameters.setPolicyScope(\"MikeAPItests\");\n //Directory will be created where the Policies are saved... this \ndisplays a a subscope on the GUI\n \n //Set the Component Attributes... These are Optional\n Map configAttributes = new HashMap<>(); \n configAttributes.put(\"Template\", \"UpdateTemplate\");\n configAttributes.put(\"controller\", \"default\"); \n configAttributes.put(\"SamPoll\", \"30\");\n configAttributes.put(\"value\", \"abcd\"); \n \n Map> attributes = new HashMap<>();\n attributes.put(AttributeType.MATCHING, configAttributes);\n \n //Set the settings... These are Optional\n Map settingsMap = new HashMap<>();\n settingsMap.put(\"server\", \"5\");\n \n attributes.put(AttributeType.SETTINGS, settingsMap);\n policyParameters.setAttributes(attributes);\n \n \n List dynamicRuleAlgorithmLabels = new LinkedList<>();\n List dynamicRuleAlgorithmFunctions = new LinkedList<>();\n List dynamicRuleAlgorithmField1 = new LinkedList<>();\n List dynamicRuleAlgorithmField2 = new LinkedList<>();\n \n //Example of a complex Rule algorithm using the settings in the Field1\n /* label field1 function field2\n * *****************************************************\n * A1 S_server integer-equal 90\n * A2 cap string-contains ca\n * A3 cobal integer-equal 90 \n * A4 A2 and A3\n * A5 Config integer-greater-than 45\n * A6 A4 ` or A5\n * A7 A1 and A6\n */\n dynamicRuleAlgorithmLabels = Arrays.asList(\"A1\",\"A2\",\"A3\",\"A4\",\"A5\",\"A6\",\"A7\");\n dynamicRuleAlgorithmField1 = Arrays.asList(\"S_server\",\"cap\",\"cobal\",\"A2\",\"Config\",\"A4\",\"A1\");\n dynamicRuleAlgorithmFunctions = Arrays.asList(\"integer-equal\",\"string-contains\",\"integer-equal\",\"and\",\"integer-greater-than\",\"or\",\"and\");\n dynamicRuleAlgorithmField2 = Arrays.asList(\"90\",\"ca\",\"90\",\"A3\",\"45\",\"A5\",\"A6\");\n \n policyParameters.setDynamicRuleAlgorithmLabels(dynamicRuleAlgorithmLabels);\n policyParameters.setDynamicRuleAlgorithmField1(dynamicRuleAlgorithmField1);\n policyParameters.setDynamicRuleAlgorithmFunctions(dynamicRuleAlgorithmFunctions);\n policyParameters.setDynamicRuleAlgorithmField2(dynamicRuleAlgorithmField2);\n \n policyParameters.setRequestID(UUID.randomUUID());\n \n // API method to create Policy or update policy\n PolicyChangeResponse response = null;\n if (!isEdit) {\n response = policyEngine.createPolicy(policyParameters);\n } else {\n response = policyEngine.updatePolicy(policyParameters);\n }\n \n if(response.getResponseCode()==200){\n System.out.println(response.getResponseMessage());\n System.out.println(\"Policy Created Successfully!\");\n }else{\n System.out.println(\"Error! \" + response.getResponseMessage());\n }\n } catch (Exception e) {\n System.err.println(e.getMessage());\n }\n }\n \n}","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"List Config Policy Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"/*-\n * ============LICENSE_START=======================================================\n * PolicyEngineClient\n * ================================================================================\n * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.\n * ================================================================================\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n * \n * http://www.apache.org/licenses/LICENSE-2.0\n * \n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n * ============LICENSE_END=========================================================\n */\n \npackage org.onap.policyEngine;\n \nimport java.util.Collection;\nimport java.util.HashMap;\nimport java.util.Map;\nimport java.util.UUID;\n \nimport org.onap.policy.api.ConfigRequestParameters;\nimport org.onap.policy.api.PolicyConfigException;\nimport org.onap.policy.api.PolicyEngine;\nimport org.onap.policy.api.PolicyEngineException;\nimport org.onap.policy.common.logging.flexlogger.FlexLogger;\nimport org.onap.policy.common.logging.flexlogger.Logger;\n \npublic class ListConfigPoliciesClient {\n \n private static final Logger LOGGER = FlexLogger.getLogger(ListConfigPoliciesClient.class);\n \n public static void main(String[] args) {\n PolicyEngine policyEngine;\n \n // List Config Policies Example \n try {\n policyEngine = new PolicyEngine(\"config.properties\");\n ConfigRequestParameters parameters = new ConfigRequestParameters();\n \n parameters.setPolicyName(\".*\");\n parameters.setOnapName(\".*\");\n parameters.setConfigName(\".*\");\n \n Map configAttributes = new HashMap<>();\n configAttributes.put(\"java\", \"java\");\n configAttributes.put(\"peach\", \"Tar\");\n configAttributes.put(\"true\", \"false\");\n configAttributes.put(\"small\", \"testPass\");\n parameters.setConfigAttributes(configAttributes);\n \n parameters.setRequestID(UUID.randomUUID());\n \n Collection response = policyEngine.listConfig(parameters);\n if(response!=null && !response.contains(\"PE300\")){\n for(String configList : response){\n System.out.println(configList.toString()+\"\\n\");\n }\n }else{\n System.out.println(\"Error! \" +response);\n }\n \n } catch (PolicyConfigException e) {\n LOGGER.error(\"Exception Occured\"+e);\n } catch (PolicyEngineException e) {\n LOGGER.error(\"Exception Occured\"+e);\n }\n }\n \n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"JSON EXAMPLES","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#0000ff"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Create Microservice Policy","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"API: createPolicy \nOPERATION: PUT\nREQUEST BODY:\n{\n \"configBody\": \"{\n\t\t\t\\\"service\\\":\\\"ControllerServiceSampleSdnlServiceInstance\\\",\n\t\t\t\\\"location\\\":\\\"Edge\\\",\n\t\t\t\\\"uuid\\\":\\\"TestUUID\\\",\n\t\t\t\\\"policyName\\\":\\\"testRestCreateMicroServicesNewParams\\\",\n\t\t\t\\\"description\\\":\\\"testing Create\\\",\n\t\t\t\\\"configName\\\":\\\"TestName\\\",\n\t\t\t\\\"templateVersion\\\":\\\"1604\\\",\n\t\t\t\\\"priority\\\":\\\"4\\\",\n\t\t\t\\\"version\\\":\\\"0.1.0-SNAPSHOT\\\",\n\t\t\t\\\"policyScope\\\":\\\"resource=F5,service=vSCP,type=configuration,closedLoopControlName=vSCP_F5_Firewall_d925ed73-8231-4d02-9545-db4e101f88f8\\\",\n\t\t\t\\\"content\\\":{\n\t\t\t\t\t\\\"taskOrchestratedConfiguration\\\":\\\"test\\\",\n\t\t\t\t\t\\\"taskCustomConfiguration\\\":\\\"set\\\",\n\t\t\t\t\t\\\"configuration\\\":\\\"test\\\",\n\t\t\t\t\t\\\"cdapUrl\\\":\\\"testurl\\\",\n\t\t\t\t\t\\\"taskName\\\":\\\"test\\\",\n\t\t\t\t\t\\\"taskNameTEST\\\":\\\"TEST\\\",\n\t\t\t\t\t\\\"users\\\":\\\"[tuser]\\\",\n\t\t\t\t\t\\\"adminUsers\\\":\\\"[lji]\\\",\n\t\t\t\t\t\\\"taskConfigFilePath\\\":\\\"test\\\",\n\t\t\t\t\t\\\"managerPortNumber\\\":\\\"999\\\",\n\t\t\t\t\t\\\"taskType\\\":\\\"test\\\",\n\t\t\t\t\t\\\"taskCommandFilePath\\\":\\\"tset\\\",\n\t\t\t\t\t\\\"contailIp\\\":\\\"test\\\",\n\t\t\t\t\t\\\"consoleUsers\\\":\\\"[odu-e2e]\\\",\n\t\t\t\t\t\\\"taskStatusFilePath\\\":\\\"test\\\"\n\t\t\t}\n\t}\",\n \"policyConfigType\": \"MicroService\",\n \"policyName\": \"MikeAPITesting.testRestCreateMicroServicesNewParams\",\n \"ecompName\": \"SDNC\"\n}\n\n","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Update Microservice Policy","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"API: updatePolicy \nOPERATION: PUT\nREQUEST BODY:\n{\n \"configBody\": \"{\n\t\t\t\\\"service\\\":\\\"ControllerServiceSampleSdnlServiceInstance\\\",\n\t\t\t\\\"location\\\":\\\"Edge\\\",\n\t\t\t\\\"uuid\\\":\\\"TestUUID\\\",\n\t\t\t\\\"policyName\\\":\\\"testRestCreateMicroServicesNewParams\\\",\n\t\t\t\\\"description\\\":\\\"testing Update\\\",\n\t\t\t\\\"configName\\\":\\\"TestName\\\",\n\t\t\t\\\"templateVersion\\\":\\\"1604\\\",\n\t\t\t\\\"priority\\\":\\\"4\\\",\n\t\t\t\\\"version\\\":\\\"0.1.0-SNAPSHOT\\\",\n\t\t\t\\\"policyScope\\\":\\\"resource=F5,service=vSCP,type=configuration,closedLoopControlName=vSCP_F5_Firewall_d925ed73-8231-4d02-9545-db4e101f88f8\\\",\n\t\t\t\\\"content\\\":{\n\t\t\t\t\t\\\"taskOrchestratedConfiguration\\\":\\\"test\\\",\n\t\t\t\t\t\\\"taskCustomConfiguration\\\":\\\"set\\\",\n\t\t\t\t\t\\\"configuration\\\":\\\"test\\\",\n\t\t\t\t\t\\\"cdapUrl\\\":\\\"testurl\\\",\n\t\t\t\t\t\\\"taskName\\\":\\\"test\\\",\n\t\t\t\t\t\\\"taskNameTEST\\\":\\\"TEST\\\",\n\t\t\t\t\t\\\"users\\\":\\\"[tuser]\\\",\n\t\t\t\t\t\\\"adminUsers\\\":\\\"[lji]\\\",\n\t\t\t\t\t\\\"taskConfigFilePath\\\":\\\"test\\\",\n\t\t\t\t\t\\\"managerPortNumber\\\":\\\"999\\\",\n\t\t\t\t\t\\\"taskType\\\":\\\"test\\\",\n\t\t\t\t\t\\\"taskCommandFilePath\\\":\\\"tset\\\",\n\t\t\t\t\t\\\"contailIp\\\":\\\"test\\\",\n\t\t\t\t\t\\\"consoleUsers\\\":\\\"[odu-e2e]\\\",\n\t\t\t\t\t\\\"taskStatusFilePath\\\":\\\"test\\\"\n\t\t\t}\n\t}\",\n \"policyConfigType\": \"MicroService\",\n \"policyName\": \"MikeAPITesting.testRestUpdateMicroServicesNewParams\",\n \"ecompName\": \"SDNC\"\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"CURL EXAMPLES","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}},{"type":"strong"}]},{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Push Policy","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"echo \"pushPolicy : PUT : com.vLoadBalancer\"\necho \"pushPolicy : PUT : com.vLoadBalancer\"\ncurl -v --silent -X PUT --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: XYZ' --header 'Authorization: Basic XYZ' --header 'Environment: TEST' -d '{\n \"pdpGroup\": \"default\",\n \"policyName\": \"com.vLoadBalancer\",\n \"policyType\": \"MicroService\"\n}' 'http://pdp:8081/pdp/api/pushPolicy'","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete Policy","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"echo \"deletePolicy : DELETE : com.vFirewall\"\ncurl -v --silent -X DELETE --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'ClientAuth: XYZ' --header 'Authorization: Basic XYZ' --header 'Environment: TEST' -d '{\n \"pdpGroup\": \"default\",\n \"policyComponent\": \"PDP\",\n \"policyName\": \"com.vFirewall\",\n \"policyType\": \"MicroService\"\n}' 'http://pdp:8081/pdp/api/deletePolicy'","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Get Config ","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"echo \"Get all Config Policy example\"\ncurl -i -v -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'ClientAuth: XYZ' -H 'Authorization: Basic XYZ -H 'Environment: TEST' -X POST -d '{\n\"policyName\": \".*\"\n}' http://${PDP_IP}:8081/pdp/api/getConfig","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"ADDITIONAL EXAMPLES","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}},{"type":"strong"}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Deleting a Policy from PAP","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"// Deleting from PAP will remove the policy from the PolicyEntity & PolicyVersion tables (UI-Editor tab).\n// This means that the policy is no longer be available in Policy System.\n\n// PayLoad:\n{ \"policyName\": \"com.testpolicy\", //scope.policyName \n \"policyType\": \"Base\", //policy type \n \"policyComponent\": \"PAP\", //component name \n \"deleteCondition\": \"ALL\" //versions (ALL or CURRENT) \n} ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Deleting a Policy from PDP","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"// Deleting from PDP will delete the policy from the PDP Group. The policy is still available in Policy System. \n// When the policy is needed again, the policy should be pushed to the PDP.\n\n// PayLoad:\n{ \"policyName\": \"com.testpolicy\", //scope.policyName \n \"policyType\": \"Base\", //policy type \n \"policyComponent\": \"PDP\", //component name \n \"pdpGroup\": \"Default\" //group name \n} ","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"POLICY ENGINE API DETAILS","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#0000ff"}}]}]},{"type":"paragraph","content":[{"text":"Header parameters apply to each API.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":1026,"id":"cb3a64ba-04fe-4906-a75b-9327c57c0bbf","collection":"contentId-16220240","type":"file","height":160}}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":1682,"id":"3d62c301-d08a-426c-8c65-4b658d1039ab","collection":"contentId-16220240","type":"file","height":3096}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported