ras.json

{
  "openrpc": "1.2.1",
  "info": {
    "title": "IBSng: branch E: ras",
    "version": "1.0.0"
  },
  "methods": [
    {
      "name": "ras.addNewRas",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE RAS"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "ras_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "ACS2",
              "Cisco-IN",
              "CiscoVPDN",
              "Generic",
              "Huawei",
              "Mikrotik",
              "Ruckus",
              "ZTE"
            ]
          }
        },
        {
          "name": "radius_secret",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "ras_description",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "comment",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (integer)",
        "summary": "Ras ID",
        "schema": {
          "title": "",
          "type": "integer"
        }
      }
    },
    {
      "name": "ras.getRasInfo",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["GET RAS INFORMATION"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "object",
          "properties": {
            "ras_ip": {
              "title": "",
              "type": "string"
            },
            "ras_id": {
              "title": "",
              "type": "integer"
            },
            "ras_description": {
              "title": "",
              "type": "string"
            },
            "radius_secret": {
              "title": "",
              "type": "string"
            },
            "comment": {
              "title": "",
              "type": "string"
            },
            "ras_type": {
              "title": "",
              "type": "string",
              "enum": [
                "ACS2",
                "Cisco-IN",
                "CiscoVPDN",
                "Generic",
                "Huawei",
                "Mikrotik",
                "Ruckus",
                "ZTE"
              ]
            },
            "attrs": {
              "title": "",
              "type": "object",
              "properties": {}
            }
          }
        }
      }
    },
    {
      "name": "ras.getActiveRasIPs",
      "description": "All active RASs, without type filter",
      "auth_type": ["ADMIN"],
      "params": [],
      "result": {
        "name": "Response (array)",
        "summary": "list of Ras IPs",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "ras.getActiveRasIPs",
      "description": "Active RASs with specific type",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "type_filter",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "list of Ras IPs",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "ras.getRasDescriptions",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [],
      "result": {
        "name": "Response (array)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "ras.getInActiveRases",
      "description": "List of inactive RAS IPs",
      "auth_type": ["ADMIN"],
      "requires_perm": ["LIST RAS"],
      "params": [],
      "result": {
        "name": "Response (array)",
        "summary": "list of RAS IPs",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "ras.getRasTypes",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["GET RAS INFORMATION"],
      "params": [],
      "result": {
        "name": "Response (array)",
        "summary": "list of RAS types",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "ras.getRasAttributes",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["GET RAS INFORMATION"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (object)",
        "summary": "RAS Attributes",
        "schema": {
          "title": "",
          "type": "object"
        }
      }
    },
    {
      "name": "ras.updateRasInfo",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "ras_id",
          "description": "",
          "schema": {
            "type": "integer"
          }
        },
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "ras_type",
          "description": "",
          "schema": {
            "type": "string",
            "enum": [
              "ACS2",
              "Cisco-IN",
              "CiscoVPDN",
              "Generic",
              "Huawei",
              "Mikrotik",
              "Ruckus",
              "ZTE"
            ]
          }
        },
        {
          "name": "radius_secret",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "ras_description",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "comment",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "ras.updateAttributes",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE RAS"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "attrs",
          "description": "",
          "schema": {
            "type": "object",
            "properties": {}
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "ras.resetAttributes",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE RAS"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "ras.deActiveRas",
      "description": "Deactivate RAS",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE RAS"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "ras.deleteRas",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE RAS"],
      "params": [
        {
          "name": "ras_id",
          "description": "",
          "schema": {
            "type": "integer"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "ras.reActiveRas",
      "description": "",
      "auth_type": ["ADMIN"],
      "requires_perm": ["CHANGE RAS"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "ras.getRasIPpools",
      "description": "Returns a sorted list of IPPool names for a RAS",
      "auth_type": ["ADMIN"],
      "requires_perm": ["GET RAS INFORMATION"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (array)",
        "summary": "list of IPPool names",
        "schema": {
          "title": "",
          "type": "array"
        }
      }
    },
    {
      "name": "ras.addIPpoolToRas",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "ippool_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    },
    {
      "name": "ras.delIPpoolFromRas",
      "description": "",
      "auth_type": ["ADMIN"],
      "params": [
        {
          "name": "ras_ip",
          "description": "",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "ippool_name",
          "description": "",
          "schema": {
            "type": "string"
          }
        }
      ],
      "result": {
        "name": "Response (null)",
        "summary": "",
        "schema": {
          "title": "",
          "type": "null"
        }
      }
    }
  ]
}