Скрипты для задач администрирования с использованием PortalPy
В этом разделе
PortalPy – это модуль Python 2.7, который позволяет создавать скрипты для выполнения общих задач администрирования вашего портала. Скрипты Python, использующие PortalPy, можно запускать с любого компьютера, имеющего доступ к порталу, если он настроен на работу с Python 2.7 (обязательно).
В этом разделе приводятся общие сведения о модуле PortalPy, включая несколько примеров и инструкций для начала работы. Использование PortalPy требует навыков написания скриптов Python, но обеспечивает наиболее гибкий способ автоматизации администрирования портала. С помощью PortalPy вы можете автоматизировать все рабочие процессы, предлагаемые утилитами командной строки, примерами скриптов Python и многое другое.
Модуль PortalPy устанавливается вместе с программным обеспечением и находится в директории tools. Пример: <Portal for ArcGIS installation directory>/tools/portalpy. Модуль PortalPy также доступен через публичный репозиторий GitHub. На этом ресурсе содержатся самые последние модули PortalPy, а также дополнительные ресурсы, полученные от сообщества пользователей. Для доступа к этому репозиторию создайте учетную запись GitHub или войдите, используя имеющуюся учетную запись GitHub.
Настройка модуля PortalPy на вашем компьютере
Чтобы создавать скрипты для администрирования с помощью PortalPy, необходимо настроить модуль PortalPy на вашем компьютере. Это может быть любой компьютер, с которого имеется доступ к порталу. Чтобы приступить к работе, см. приведенные ниже шаги.
- На компьютере с Portal for ArcGIS найдите <Portal for ArcGIS installation directory>/tools и скопируйте всю папку portalpy в локальную директорию на своем компьютере. Пример: /home/admin/portalpy. Вы можете пропустить этот шаг, если на компьютере, на котором вы собираетесь запустить модуль PortalPy, установлен Portal for ArcGIS.
- На компьютере с модулем PortalPy задайте переменную среды PYTHONPATH. Укажите путь к директории, где находится portalpy.py. Например, export PYTHONPATH=$PYTHONPATH:/home/admin/portalpy.
- Создайте файл test.py и поместите его в ту же директорию, где находится portalpy.py. Пример: /home/admin/portalpy.
- Скопируйте следующий код в этот файл и обновите URL, чтобы он совпадал с URL портала.
#!/usr/bin/python import portalpy url = "https://portal.domain.com/arcgis" portal = portalpy.Portal(url) print portal.get_version()
- Сохраните и закройте файл.
- Запустите test.py. Скрипт отобразит номер версии, например – 3.2.
Теперь компьютер настроен на работу с модулем PortalPy.
Документация к модулю PortalPy
Чтобы просмотреть классы и методы, входящие в PortalPy, см. раздел Модуль PortalPy. В этом разделе приводятся примеры, которые помогут изучить программирование в ArcGIS REST API с использованием модуля PortalPy.
Примеры скриптов
К стандартным задачам администрирования, которые можно автоматизировать с помощью PortalPy, относятся:
Пример: Список пользователей в группе
portal = PortalPy.Portal(portalUrl, user, password)
resp = portal.get_group_members('67e1761068b7453693a0c68c92a62e2e')
for user in resp['users']:
print user
Пример: Создание группы
portal= PortalPy.Portal(portalUrl, user, password)
group_id = portalAdmin.create_group('my group', 'test tag', 'a group to share travel maps')
Пример: Удаление пользователя и передача его ресурсов другому пользователю
portal= PortalPy.Portal(portalUrl, user, password)
portal.delete_user('amy.user', True, 'bob.user')