学习笔记：基于python的JumpServer api自动化操作开发

cykablyta

已于 2022-09-27 17:03:23 修改

阅读量3.4k

点赞数 13

文章标签：自动化运维 python 中间件

于 2022-08-19 17:48:25 首次发布

本文链接：https://blog.csdn.net/cykablyta/article/details/126425948

版权

jumpserver api认证方法文档：API 文档 - JumpServer 文档

api文档：http://jumpserver地址（可能要端口号）/api/docs

领导要求把jumpserver、prometheus之类的新加入设备的操作都给自动化了，然后整合到公司的网页上。先在自己虚拟环境整个jumpserver环境用来测试：（安装过程略）

首先使用token连接上jumpserver并尝试用get方法获取用户列表（用例来自官方文档）

import requests, json

def get_token(jms_url, username, password):
    url = jms_url + '/api/v1/authentication/auth/'
    query_args = {
        "username": username,
        "password": password
    }
    response = requests.post(url, data=query_args)
    return json.loads(response.text)['token']

def get_user_info(jms_url, token):#获取所有jumpserver用户
    url = jms_url + '/api/v1/users/users/'
    headers = {
        "Authorization": 'Bearer ' + token,
        'X-JMS-ORG': '00000000-0000-0000-0000-000000000002'
    }
    response = requests.get(url, headers=headers)
    print(json.loads(response.text))


if __name__ == '__main__':
    jms_url = 'https://192.168.80.129:80'#jumpserver地址
    username = 'user1'#jumpserver管理员的用户名和密码
    password = '123456'
    token = get_token(jms_url, username, password)
    get_user_info(jms_url, token)

如果出现错误[SSL: WRONG_VERSION_NUMBER] wrong version number (_ssl.c:1125)，修改url为http；如果出现“由于目标计算机积极拒绝，无法连接”，url加一下端口号，默认80或443。

由于本用例请求用户列表，只要发送get请求即可，无需发送数据，自然无需标注数据类型。

然后尝试用post方法添加jumpserver用户

def create_user(jms_url, token):
    url = jms_url + '/api/v1/users/users/'
    headers = {
        "Authorization": 'Bearer ' + token,
        'X-JMS-ORG': '00000000-0000-0000-0000-000000000002',
        'accept': 'application/json',
        'Content-Type': 'application/json'
    }#加上传参类型accept和Content-Type

    data={
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "username": "string",
  "password": "string",
  "public_key": "string",
  "email": "user@example.com",
  "wechat": "string",
  "phone": "string",
  "mfa_level": 0,
  "source": "local",
  "need_update_password": False,
  "is_active": True,
  "date_expired": "2022-08-19T07:53:50.650Z",
  "comment": "string",
  "role": "User",
  "groups": [
    "915922ca-6106-40c3-8b46-54bc7bbc0f23"
  ],
  "org_roles": [
    "Admin"
  ],
  "password_strategy": "email"
}
#groups应为预设好存在的组的id，样例json中true和false在字典中记得大写
    data_json = json.dumps(data)
    response = requests.post(url,data_json, headers=headers)
    print(response.text)

1.id和groups的编码是有格式要求的，groups需要已经创建好的，可以去ui界面去查（1.5没有，需要在ui界面看url后面带的参数或者用api获取）而id不是必须项，可以删掉，让系统自己生成；实际上只需要留必须的几项就可以成功创建。

传参json格式参考api文档。

经过测试，用户列表里确实多了个用户，说明api可用，测试成功。下面面向公司jumpserver进行开发。

一个注意点：我的环境是2.6最新版，但是公司是1.5，差有点多；好在各个版本都自带api文档。（渴望一份各个api操作的详细解读）

现在要在脚本中完成的步骤：添加新资产（资产名称，ip，系统基本都是linux，管理用户都是root，节点需要前端来选择）-》资产授权（名称，资产，节点，系统用户为固定的几个，动作全选）

首先找到添加资产的api #有一说一，jumpserver应该是所有的操作都能用api完成，可是这一大面英文指标想找个啥太难了，不过感谢这位的文章，参照下找到添加资产的api：/assets/assets/

Jumpserver通过API自动添加资产-

tips：在把操作写进程序之前，可以在api文档中进行简单测试

自己调整参数，看运行的结果，相当方便，然后整合进代码就可以了。

添加资产

def create_assest(jms_url, token):
    url = jms_url + '/api/v1/assets/assets/'
    headers = {
        "Authorization": 'Bearer ' + token,
        'X-JMS-ORG': '00000000-0000-0000-0000-000000000002',
        'accept': 'application/json',
        'Content-Type': 'application/json'
    }

    data={
  "ip": "192.168.100.71",
  "hostname": "test_kvm71",
  "platform": "Linux",
  "is_active": True,
  "admin_user": "5635e492-bb0b-4aaf-94d1-b2b0cf16c616",
  "nodes": [
    "0fad765c-8965-4db2-9fd0-5bd2b83a2e91"
  ]

}
    data_json = json.dumps(data)
    response = requests.post(url,data_json, headers=headers)
    print(response.text)

添加授权规则

def permission(jms_url, token):
    url = jms_url + '/api/v1/perms/asset-permissions/'
    headers = {
        "Authorization": 'Bearer ' + token,
        'X-JMS-ORG': '00000000-0000-0000-0000-000000000002',
        'accept': 'application/json',
        'Content-Type': 'application/json'
    }

    data={
  "actions": [
    "all"
  ],
  "name": "test4-kvm71",
  "is_active": True,
  "date_start": "2022-08-23T01:32:06.560Z",
  "date_expired": "2092-08-23T01:32:06.560Z",
  "users": [
    "3bee8208-879f-46a5-a004-9e2a739e2592"
  ],
  "assets": [
    "0cdc877d-fbb7-4e7c-af2d-2e8def6120ed"
  ],
  "system_users": [
    "1ae8d4da-1a4a-4dcc-a7a6-30a2be738044"
}
    data_json = json.dumps(data)
    response = requests.post(url,data_json, headers=headers)
    print(response.text)

然后就可以登录了。

我的1.5版本jumpserver有个大问题：创建好了资产、授权规则在前端显示不出来，但实际上能够登录资产，说明已经添加进数据库，但是前端未加载。这个问题在查验数据库之后得到了解决，罪魁祸首就是'X-JMS-ORG': '00000000-0000-0000-0000-000000000002'这个字段，1.5版本的其他资产都没有这个字段，改成空的就行了。但是在新版本里是没有问题的。