aboutsummaryrefslogtreecommitdiffstats
path: root/appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/openecomp/appc/adapter/netconf/NetconfConnectionDetails.java
diff options
context:
space:
mode:
Diffstat (limited to 'appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/openecomp/appc/adapter/netconf/NetconfConnectionDetails.java')
-rw-r--r--appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/openecomp/appc/adapter/netconf/NetconfConnectionDetails.java92
1 files changed, 92 insertions, 0 deletions
diff --git a/appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/openecomp/appc/adapter/netconf/NetconfConnectionDetails.java b/appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/openecomp/appc/adapter/netconf/NetconfConnectionDetails.java
new file mode 100644
index 000000000..fdbda2916
--- /dev/null
+++ b/appc-adapters/appc-netconf-adapter/appc-netconf-adapter-bundle/src/main/java/org/openecomp/appc/adapter/netconf/NetconfConnectionDetails.java
@@ -0,0 +1,92 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * openECOMP : APP-C
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights
+ * reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.openecomp.appc.adapter.netconf;
+
+import java.util.List;
+import java.util.Properties;
+
+/**
+ * Provides details required for connecting to netconf device.
+ */
+public class NetconfConnectionDetails {
+
+ private String host;
+ private int port;
+ private String username;
+ private String password;
+
+ public static int DEFAULT_PORT = 830;
+ private List<String> capabilities;
+ private Properties additionalProperties;
+
+ public NetconfConnectionDetails() {
+ super();
+ setPort(DEFAULT_PORT);
+ }
+ public String getHost() {
+ return host;
+ }
+
+ public void setHost(String host) {
+ this.host = host;
+ }
+
+ public int getPort() {
+ return port;
+ }
+
+ public void setPort(int port) {
+ this.port = port;
+ }
+
+ public String getUsername() {
+ return username;
+ }
+
+ public void setUsername(String username) {
+ this.username = username;
+ }
+
+ public String getPassword() {
+ return password;
+ }
+
+ public void setPassword(String password) {
+ this.password = password;
+ }
+
+ public List<String> getCapabilities() {
+ return capabilities;
+ }
+
+ public void setCapabilities(List<String> capabilities) {
+ this.capabilities = capabilities;
+ }
+
+ public Properties getAdditionalProperties() {
+ return additionalProperties;
+ }
+
+ public void setAdditionalProperties(Properties additionalProperties) {
+ this.additionalProperties = additionalProperties;
+ }
+}
: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ }
open_cli_schema_version: 1.0
name: vnf-checklock
description: The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned

info:
  product: onap-beijing
  service: appc
  author: ONAP CLI Team onap-discuss@lists.onap.org
  state: experimental

parameters:
  - name: timestamp
    description: The time of the request, in ISO 8601 format, ZULU offset
    type: string
    short_option: T
    long_option: timestamp
    is_optional: false
  - name: api-ver
    description: Identifies the API version
    type: string
    short_option: X
    long_option: api-ver
    is_optional: false
  - name: originator-id
    description: An identifier of the calling system limited to a length of 40 characters
    type: string
    short_option: O
    long_option: originator-id
    is_optional: false
  - name: request-id
    description: The UUID for the request ID, limited to a length of 40 characters
    type: string
    short_option: R
    long_option: request-id
    is_optional: false
  - name: sub-request-id
    description: Uniquely identifies a specific LCM or control action, limited to a length of 40 characters
    type: string
    short_option: W
    long_option: sub-request-id
    is_optional: true
  - name: flags-mode
    description: Generic flags-mode that apply to all LCM actions
    type: string
    short_option: F
    is_optional: true
  - name: flags-force
    description: Generic flags-force that apply to all LCM actions
    type: bool
    short_option: G
    is_optional: true
  - name: flags-ttl
    description: Generic flags-ttl that apply to all LCM actions
    type: string
    short_option: H
    is_optional: true
  - name: action
    description: The action to be taken by APPC
    type: string
    short_option: A
    long_option: action
    is_optional: false
  - name: service-instance-id
    description: Identifies a specific service instance that the command refers to
    type: string
    short_option: S
    long_option: service-instance-id
    is_optional: true
  - name: vnf-id
    description: Identifies the VNF instance to which this action is to be applied
    type: string
    short_option: J
    long_option: vnf-id
    is_optional: true
    is_optional: false
  - name: vnfc-name
    description: Identifies the VNFC name to which this action is to be applied
    type: string
    short_option: N
    long_option: vnfc-name
    is_optional: true
  - name: vserver-id
    description: Identifies a specific VM instance to which this action is to be applied
    type: string
    short_option: K
    long_option: vserver-id
    is_optional: true
  - name: vf-module-id
    description: Identifies a specific VF module to which this action is to be applied
    type: string
    short_option: M
    long_option: vf-module-id
    is_optional: true
  - name: payload
    description: An action-specific open-format field
    type: string
    short_option: P
    long_option: payload
    is_optional: true
results:
  direction: portrait
  attributes:
    - name: action
      description: The action to be taken by APPC
      scope: short
      type: string
    - name: api-ver
      description: Identifies the API version
      scope: short
      type: string
    - name: flags
      description: Identifies the API version
      scope: short
      type: string
    - name: timestamp
      description: The time of the request, in ISO 8601 format, ZULU offset
      scope: short
      type: string
    - name: status
      description: The status describes the outcome of the command processing
      scope: short
      type: digit
    - name: originator-id
      description: An identifier of the calling system limited to a length of 40 characters
      scope: short
      type: string
    - name: request-id
      description: The UUID for the request ID, limited to a length of 40 characters
      scope: short
      type: string
    - name: sub-request-id
      description: Uniquely identifies a specific LCM or control action
      scope: long
      type: string
    - name: payload
      description: An open-format field
      scope: long
      type: string
http:
  service:
    auth: basic
    mode: direct
  request:
    uri: /restconf/operations/vnf-provider-lcm:check-lock
    method: POST
    body: '{"input":{"common-header":{"timestamp": "${timestamp}","api-ver": "${api-ver}","originator-id": "${originator-id}","request-id": "${request-id}","sub-request-id": "${sub-request-id}","flags":{"mode":"${flags-mode}","force":"${flags-force}","ttl":"${flags-ttl}"}},"action":"${action}","action-identifiers":{"vnf-id": "${vnf-id}","vnfc-name": "${vnfc-name}","vserver-id": "${vserver-id}"},"payload": "${payload}"}}'
  success_codes:
    - 100
    - 400
  result_map:
    action: $b{$.action}
    api-ver: $b{$.api-ver}
    flags: $b{$.flags}
    originator-id: $b{$.originator-id}
    request-id: $b{$.request-id}
    sub-request-id: $b{$.sub-request-id}
    payload: $b{$.payload}
    status: $b{$.status}
    timestamp: $b{$.timestamp}

  sample_response:
    body: '{"output":{"common-header":{"api-ver": "${api-ver}","flags":"${flags}","originator-id": "${originator-id}","request-id": "${request-id}", "sub-request-id": "${sub-request-id}", "timestamp": "${timestamp}"},"payload": "${payload}","status": "${status}"}}'